From 833c7f8ace955308ac07f26742fa7f5ec83da7b3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Jun 2023 10:00:25 +0000 Subject: [PATCH 001/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index adf2053..cf14ce2 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-base-filled-by": "^0.0.2", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 5f59a7ba247efe6636587e12dd6ebc8a484f2142 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Jun 2023 18:17:55 +0000 Subject: [PATCH 002/123] 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 | 52 - benchmark/benchmark.length.js | 99 - branches.md | 53 - docs/repl.txt | 32 - docs/types/test.ts | 57 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 43 - lib/main.js | 51 - package.json | 60 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 86 - 38 files changed, 6202 insertions(+), 3674 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 benchmark/benchmark.length.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 (93%) 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 73eaac8..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-06-01T06:31:51.647Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 48e056d..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/take) 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 5ee7624..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/take) 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 62c41e4..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: '11 23 * * 4' - - # 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 + + ```
@@ -132,7 +125,7 @@ console.log( y ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ae80e93..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 9bd4744..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = filledBy( len, discreteUniform( 0, 3 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fa94502..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index bedbcf0..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,32 +0,0 @@ - -{{alias}}( x, indices ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - The function does *not* perform bounds checking. If an index is less than - zero or greater than the maximum index of `x`, the value of the - corresponding element in the output array is undefined. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ] ) - [ 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index f9a8449..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ] ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ] ); // $ExpectError - take( true, [ 1, 3 ] ); // $ExpectError - take( false, [ 1, 3 ] ); // $ExpectError - take( null, [ 1, 3 ] ); // $ExpectError - take( void 0, [ 1, 3 ] ); // $ExpectError - take( {}, [ 1, 3 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1 ); // $ExpectError - take( [], true ); // $ExpectError - take( [], false ); // $ExpectError - take( [], null ); // $ExpectError - take( [], void 0 ); // $ExpectError - take( [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [], [] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 71354ad..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); - -// Take a random sample of elements from `x`: -var y = take( x, indices ); - -console.log( x ); -console.log( indices ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index 4c9cd5e..b28a056 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d82d372 --- /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 +/// +function r(r,t){var e,n;for(e=[],n=0;n=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -82,4 +28,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..6618564 --- /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 fc93702..0000000 --- a/test/test.js +++ /dev/null @@ -1,86 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function does not perform bounds checking', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 4, 5, 1, 2 ]; - actual = take( x, indices ); - expected = [ void 0, void 0, 2, 3 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [] ), [], 'returns expected value' ); - t.end(); -}); From 465bd38dc900cd1a5623f1cd5c3e092e975d9d48 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Jul 2023 09:26:23 +0000 Subject: [PATCH 003/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index adf2053..cf14ce2 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-base-filled-by": "^0.0.2", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 35721331c66ea090730c371de0ac294805c0f21e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Jul 2023 18:34:24 +0000 Subject: [PATCH 004/123] Remove files --- index.d.ts | 47 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6229 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 b28a056..0000000 --- a/index.d.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { ArrayLike } from '@stdlib/types/array'; - -/** -* Takes element from an array. -* -* ## Notes -* -* - The function does **not** perform bounds checking. If an index is less than zero or greater than the maximum index of `x`, the value of the corresponding element in the output array is undefined. -* -* @param x - input array -* @param indices - list of element indices -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ] ); -* // returns [ 2, 4 ] -*/ -declare function take( x: ArrayLike, indices: ArrayLike ): Array; // tslint:disable-line:max-line-length - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d82d372..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 -/// -function r(r,t){var e,n;for(e=[],n=0;n - - - - - - Rollup Visualizer - - - -
- - - - - From 515471e1eb17a2f7e8e3b48f5dfd0b7b36a8c451 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Jul 2023 18:35:21 +0000 Subject: [PATCH 005/123] 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 | 52 - benchmark/benchmark.length.js | 99 - branches.md | 53 - docs/repl.txt | 32 - docs/types/test.ts | 57 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 43 - lib/main.js | 51 - package.json | 60 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 86 - 38 files changed, 6202 insertions(+), 3674 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 benchmark/benchmark.length.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 (93%) 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 92d0629..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-07-01T06:22:47.374Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 48e056d..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/take) 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 5ee7624..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/take) 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 62c41e4..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: '11 23 * * 4' - - # 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 + + ```
@@ -132,7 +125,7 @@ console.log( y ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ae80e93..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 9bd4744..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = filledBy( len, discreteUniform( 0, 3 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fa94502..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index bedbcf0..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,32 +0,0 @@ - -{{alias}}( x, indices ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - The function does *not* perform bounds checking. If an index is less than - zero or greater than the maximum index of `x`, the value of the - corresponding element in the output array is undefined. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ] ) - [ 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index f9a8449..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ] ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ] ); // $ExpectError - take( true, [ 1, 3 ] ); // $ExpectError - take( false, [ 1, 3 ] ); // $ExpectError - take( null, [ 1, 3 ] ); // $ExpectError - take( void 0, [ 1, 3 ] ); // $ExpectError - take( {}, [ 1, 3 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1 ); // $ExpectError - take( [], true ); // $ExpectError - take( [], false ); // $ExpectError - take( [], null ); // $ExpectError - take( [], void 0 ); // $ExpectError - take( [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [], [] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 71354ad..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); - -// Take a random sample of elements from `x`: -var y = take( x, indices ); - -console.log( x ); -console.log( indices ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index 4c9cd5e..b28a056 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d82d372 --- /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 +/// +function r(r,t){var e,n;for(e=[],n=0;n=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -82,4 +28,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..8b436aa --- /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 fc93702..0000000 --- a/test/test.js +++ /dev/null @@ -1,86 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function does not perform bounds checking', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 4, 5, 1, 2 ]; - actual = take( x, indices ); - expected = [ void 0, void 0, 2, 3 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [] ), [], 'returns expected value' ); - t.end(); -}); From b8bf767df11cb95233d8e7e0b38cdef5d97d9a5e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 19 Aug 2023 01:34:23 +0000 Subject: [PATCH 006/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index adf2053..cf14ce2 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-base-filled-by": "^0.0.2", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 18d1cd22aaf0979115dca0ba7b548f39a179a057 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 19 Aug 2023 01:35:58 +0000 Subject: [PATCH 007/123] Remove files --- index.d.ts | 47 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6229 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 b28a056..0000000 --- a/index.d.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { ArrayLike } from '@stdlib/types/array'; - -/** -* Takes element from an array. -* -* ## Notes -* -* - The function does **not** perform bounds checking. If an index is less than zero or greater than the maximum index of `x`, the value of the corresponding element in the output array is undefined. -* -* @param x - input array -* @param indices - list of element indices -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ] ); -* // returns [ 2, 4 ] -*/ -declare function take( x: ArrayLike, indices: ArrayLike ): Array; // tslint:disable-line:max-line-length - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d82d372..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 -/// -function r(r,t){var e,n;for(e=[],n=0;n - - - - - - Rollup Visualizer - - - -
- - - - - From 118fda651656a919092ff6e04233c7e70c603a1f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 19 Aug 2023 01:37:01 +0000 Subject: [PATCH 008/123] 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 | 52 - benchmark/benchmark.length.js | 99 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 32 - docs/types/test.ts | 57 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 43 - lib/main.js | 51 - package.json | 60 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 86 - 40 files changed, 6202 insertions(+), 3673 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 benchmark/benchmark.length.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 (93%) 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 48e056d..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/take) 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 5ee7624..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/take) 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 62c41e4..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: '11 23 * * 4' - - # 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 + + ```
@@ -132,7 +125,7 @@ console.log( y ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ae80e93..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 9bd4744..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = filledBy( len, discreteUniform( 0, 3 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fa94502..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 49ce5c8..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var a=o(function(v,s){ -function i(e,r){var u,t;for(u=[],t=0;t - List of element indices. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ] ) - [ 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index f9a8449..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ] ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ] ); // $ExpectError - take( true, [ 1, 3 ] ); // $ExpectError - take( false, [ 1, 3 ] ); // $ExpectError - take( null, [ 1, 3 ] ); // $ExpectError - take( void 0, [ 1, 3 ] ); // $ExpectError - take( {}, [ 1, 3 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1 ); // $ExpectError - take( [], true ); // $ExpectError - take( [], false ); // $ExpectError - take( [], null ); // $ExpectError - take( [], void 0 ); // $ExpectError - take( [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [], [] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 71354ad..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); - -// Take a random sample of elements from `x`: -var y = take( x, indices ); - -console.log( x ); -console.log( indices ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index 3f5332a..1c93f01 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d82d372 --- /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 +/// +function r(r,t){var e,n;for(e=[],n=0;n=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -82,4 +28,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..688c006 --- /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 fc93702..0000000 --- a/test/test.js +++ /dev/null @@ -1,86 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function does not perform bounds checking', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 4, 5, 1, 2 ]; - actual = take( x, indices ); - expected = [ void 0, void 0, 2, 3 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [] ), [], 'returns expected value' ); - t.end(); -}); From ea2f225194e45befc0f67d1e1591034b32bfc7ab Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 24 Aug 2023 22:00:35 +0000 Subject: [PATCH 009/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index adf2053..cf14ce2 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-base-filled-by": "^0.0.2", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 264aff8b08c3bed439076b14780a3ae3465a286d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 24 Aug 2023 22:03:45 +0000 Subject: [PATCH 010/123] Remove files --- index.d.ts | 47 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6229 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 1c93f01..0000000 --- a/index.d.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { ArrayLike } from '@stdlib/types/array'; - -/** -* Takes element from an array. -* -* ## Notes -* -* - The function does **not** perform bounds checking. If an index is less than zero or greater than the maximum index of `x`, the value of the corresponding element in the output array is undefined. -* -* @param x - input array -* @param indices - list of element indices -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ] ); -* // returns [ 2, 4 ] -*/ -declare function take( x: ArrayLike, indices: ArrayLike ): Array; // tslint:disable-line:max-line-length - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d82d372..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 -/// -function r(r,t){var e,n;for(e=[],n=0;n - - - - - - Rollup Visualizer - - - -
- - - - - From e0463b069c60c4e26db0dd52c2dddc4e74925e64 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 24 Aug 2023 22:04:41 +0000 Subject: [PATCH 011/123] 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 | 52 - benchmark/benchmark.length.js | 99 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 32 - docs/types/test.ts | 57 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 43 - lib/main.js | 51 - package.json | 60 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 86 - 40 files changed, 6202 insertions(+), 3673 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 benchmark/benchmark.length.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 (93%) 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 48e056d..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/take) 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 5ee7624..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/take) 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 62c41e4..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: '11 23 * * 4' - - # 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 + + ```
@@ -132,7 +125,7 @@ console.log( y ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ae80e93..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 9bd4744..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = filledBy( len, discreteUniform( 0, 3 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fa94502..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 49ce5c8..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var a=o(function(v,s){ -function i(e,r){var u,t;for(u=[],t=0;t - List of element indices. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ] ) - [ 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index f9a8449..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ] ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ] ); // $ExpectError - take( true, [ 1, 3 ] ); // $ExpectError - take( false, [ 1, 3 ] ); // $ExpectError - take( null, [ 1, 3 ] ); // $ExpectError - take( void 0, [ 1, 3 ] ); // $ExpectError - take( {}, [ 1, 3 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1 ); // $ExpectError - take( [], true ); // $ExpectError - take( [], false ); // $ExpectError - take( [], null ); // $ExpectError - take( [], void 0 ); // $ExpectError - take( [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [], [] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 71354ad..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); - -// Take a random sample of elements from `x`: -var y = take( x, indices ); - -console.log( x ); -console.log( indices ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index 62d1d0d..0e6bfce 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..d82d372 --- /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 +/// +function r(r,t){var e,n;for(e=[],n=0;n=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -82,4 +28,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..6a997c9 --- /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 fc93702..0000000 --- a/test/test.js +++ /dev/null @@ -1,86 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function does not perform bounds checking', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 4, 5, 1, 2 ]; - actual = take( x, indices ); - expected = [ void 0, void 0, 2, 3 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [] ), [], 'returns expected value' ); - t.end(); -}); From dd727937df7cae4e64a7fb5ea9d7b563d7bb76b3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 06:34:23 +0000 Subject: [PATCH 012/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 2d12210..695776d 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-base-filled-by": "^0.0.2", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 847fd07a7d496b6efbe64a3d7063318d28eb6c00 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 08:52:04 +0000 Subject: [PATCH 013/123] Remove files --- index.d.ts | 47 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6229 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 0e6bfce..0000000 --- a/index.d.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Takes element from an array. -* -* ## Notes -* -* - The function does **not** perform bounds checking. If an index is less than zero or greater than the maximum index of `x`, the value of the corresponding element in the output array is undefined. -* -* @param x - input array -* @param indices - list of element indices -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ] ); -* // returns [ 2, 4 ] -*/ -declare function take( x: Collection, indices: Collection ): Array; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d82d372..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 -/// -function r(r,t){var e,n;for(e=[],n=0;n - - - - - - Rollup Visualizer - - - -
- - - - - From 5b40332b28b228666424fe776321c1259fd15d85 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 08:53:50 +0000 Subject: [PATCH 014/123] 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 | 52 - benchmark/benchmark.length.js | 99 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 32 - docs/types/test.ts | 57 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 43 - lib/main.js | 51 - package.json | 60 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 86 - 41 files changed, 6202 insertions(+), 3708 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 benchmark/benchmark.length.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 (93%) 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 48e056d..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/take) 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 5ee7624..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/take) 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 62c41e4..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: '11 23 * * 4' - - # 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 + + ```
@@ -143,7 +136,7 @@ console.log( y ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ae80e93..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 9bd4744..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = filledBy( len, discreteUniform( 0, 3 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fa94502..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 49ce5c8..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var a=o(function(v,s){ -function i(e,r){var u,t;for(u=[],t=0;t - List of element indices. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ] ) - [ 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index f9a8449..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ] ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ] ); // $ExpectError - take( true, [ 1, 3 ] ); // $ExpectError - take( false, [ 1, 3 ] ); // $ExpectError - take( null, [ 1, 3 ] ); // $ExpectError - take( void 0, [ 1, 3 ] ); // $ExpectError - take( {}, [ 1, 3 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1 ); // $ExpectError - take( [], true ); // $ExpectError - take( [], false ); // $ExpectError - take( [], null ); // $ExpectError - take( [], void 0 ); // $ExpectError - take( [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [], [] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 71354ad..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); - -// Take a random sample of elements from `x`: -var y = take( x, indices ); - -console.log( x ); -console.log( indices ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index 62d1d0d..0e6bfce 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..d82d372 --- /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 +/// +function r(r,t){var e,n;for(e=[],n=0;n=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -82,4 +28,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..23bf57f --- /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 fc93702..0000000 --- a/test/test.js +++ /dev/null @@ -1,86 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function does not perform bounds checking', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 4, 5, 1, 2 ]; - actual = take( x, indices ); - expected = [ void 0, void 0, 2, 3 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [] ), [], 'returns expected value' ); - t.end(); -}); From 40cdf8146e7111782570b8021b2034b4683205a8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 10:40:22 +0000 Subject: [PATCH 015/123] 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 4afde62..0778fc6 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ limitations under the License. ## Usage ```javascript -import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.1.0-esm/index.mjs'; ``` #### take( x, indices ) @@ -94,7 +94,7 @@ var y = take( x, [] ); import filledBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs'; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@esm/index.mjs'; import linspace from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-linspace@esm/index.mjs'; -import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.1.0-esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From 15c8c50104d859ece349141dcf9609b76f9275fb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 10:40:23 +0000 Subject: [PATCH 016/123] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0778fc6..a04464d 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,11 @@ limitations under the License. ## Usage +```javascript +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@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-take/tags). For example, + ```javascript import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.1.0-esm/index.mjs'; ``` @@ -94,7 +99,7 @@ var y = take( x, [] ); import filledBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs'; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@esm/index.mjs'; import linspace from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-linspace@esm/index.mjs'; -import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.1.0-esm/index.mjs'; +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From c46f24c5eaa6b8be372dcd06a0f884f966fcbc46 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Oct 2023 14:13:46 +0000 Subject: [PATCH 017/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index d915025..ad48d3d 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-base-filled-by": "^0.1.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From e76633876527d8d69b73a3cee787dbcf478e4531 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Oct 2023 22:22:50 +0000 Subject: [PATCH 018/123] Remove files --- index.d.ts | 47 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6229 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 0e6bfce..0000000 --- a/index.d.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Takes element from an array. -* -* ## Notes -* -* - The function does **not** perform bounds checking. If an index is less than zero or greater than the maximum index of `x`, the value of the corresponding element in the output array is undefined. -* -* @param x - input array -* @param indices - list of element indices -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ] ); -* // returns [ 2, 4 ] -*/ -declare function take( x: Collection, indices: Collection ): Array; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d82d372..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 -/// -function r(r,t){var e,n;for(e=[],n=0;n - - - - - - Rollup Visualizer - - - -
- - - - - From d6215d16f0eaecad86e3c9469178b30d10154472 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Oct 2023 22:25:55 +0000 Subject: [PATCH 019/123] 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 | 52 - benchmark/benchmark.length.js | 99 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 32 - docs/types/test.ts | 57 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 43 - lib/main.js | 51 - package.json | 60 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 86 - test/test.js | 86 - 43 files changed, 6202 insertions(+), 3853 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 benchmark/benchmark.length.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 (93%) 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 b916099..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-10-01T04:20:56.857Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 48e056d..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/take) 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 2e83b65..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/take) 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 c64025f..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: '11 23 * * 4' - - # 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 + + ```
@@ -143,7 +136,7 @@ console.log( y ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ae80e93..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 9bd4744..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = filledBy( len, discreteUniform( 0, 3 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fa94502..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 49ce5c8..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var a=o(function(v,s){ -function i(e,r){var u,t;for(u=[],t=0;t - List of element indices. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ] ) - [ 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index f9a8449..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ] ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ] ); // $ExpectError - take( true, [ 1, 3 ] ); // $ExpectError - take( false, [ 1, 3 ] ); // $ExpectError - take( null, [ 1, 3 ] ); // $ExpectError - take( void 0, [ 1, 3 ] ); // $ExpectError - take( {}, [ 1, 3 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1 ); // $ExpectError - take( [], true ); // $ExpectError - take( [], false ); // $ExpectError - take( [], null ); // $ExpectError - take( [], void 0 ); // $ExpectError - take( [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [], [] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 71354ad..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); - -// Take a random sample of elements from `x`: -var y = take( x, indices ); - -console.log( x ); -console.log( indices ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index 62d1d0d..0e6bfce 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..d82d372 --- /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 +/// +function r(r,t){var e,n;for(e=[],n=0;n=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -82,4 +28,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..56b24a2 --- /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 52dda32..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,86 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 take = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function does not perform bounds checking', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 4, 5, 1, 2 ]; - actual = take( x, indices ); - expected = [ void 0, void 0, 2, 3 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [] ), [], 'returns expected value' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index fc93702..0000000 --- a/test/test.js +++ /dev/null @@ -1,86 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function does not perform bounds checking', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 4, 5, 1, 2 ]; - actual = take( x, indices ); - expected = [ void 0, void 0, 2, 3 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [] ), [], 'returns expected value' ); - t.end(); -}); From 9bf8f76592893e37d7d694d248b7d82b99fc5bd4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 5 Oct 2023 17:40:04 +0000 Subject: [PATCH 020/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 680d3a7..c9c0bc2 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-base-filled-by": "^0.1.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 65d3a8b1d5040a014a07acc57f854efe2fe380ca Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 6 Oct 2023 23:30:29 +0000 Subject: [PATCH 021/123] Remove files --- index.d.ts | 47 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6229 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 0e6bfce..0000000 --- a/index.d.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Takes element from an array. -* -* ## Notes -* -* - The function does **not** perform bounds checking. If an index is less than zero or greater than the maximum index of `x`, the value of the corresponding element in the output array is undefined. -* -* @param x - input array -* @param indices - list of element indices -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ] ); -* // returns [ 2, 4 ] -*/ -declare function take( x: Collection, indices: Collection ): Array; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d82d372..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 -/// -function r(r,t){var e,n;for(e=[],n=0;n - - - - - - Rollup Visualizer - - - -
- - - - - From 876188732aaf685257a5c51347d74da72e059156 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 6 Oct 2023 23:33:35 +0000 Subject: [PATCH 022/123] 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 | 52 - benchmark/benchmark.length.js | 99 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 32 - docs/types/test.ts | 57 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 43 - lib/main.js | 51 - package.json | 60 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 86 - test/test.js | 86 - 42 files changed, 6202 insertions(+), 3852 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 benchmark/benchmark.length.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 (93%) 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 48e056d..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/take) 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 2e83b65..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/take) 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 c64025f..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: '11 23 * * 4' - - # 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 + + ```
@@ -143,7 +136,7 @@ console.log( y ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ae80e93..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 9bd4744..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = filledBy( len, discreteUniform( 0, 3 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fa94502..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 49ce5c8..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var a=o(function(v,s){ -function i(e,r){var u,t;for(u=[],t=0;t - List of element indices. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ] ) - [ 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index f9a8449..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ] ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ] ); // $ExpectError - take( true, [ 1, 3 ] ); // $ExpectError - take( false, [ 1, 3 ] ); // $ExpectError - take( null, [ 1, 3 ] ); // $ExpectError - take( void 0, [ 1, 3 ] ); // $ExpectError - take( {}, [ 1, 3 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1 ); // $ExpectError - take( [], true ); // $ExpectError - take( [], false ); // $ExpectError - take( [], null ); // $ExpectError - take( [], void 0 ); // $ExpectError - take( [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [], [] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 71354ad..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); - -// Take a random sample of elements from `x`: -var y = take( x, indices ); - -console.log( x ); -console.log( indices ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index 62d1d0d..0e6bfce 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..d82d372 --- /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 +/// +function r(r,t){var e,n;for(e=[],n=0;n=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -82,4 +28,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..7b8f899 --- /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 52dda32..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,86 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 take = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function does not perform bounds checking', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 4, 5, 1, 2 ]; - actual = take( x, indices ); - expected = [ void 0, void 0, 2, 3 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [] ), [], 'returns expected value' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index fc93702..0000000 --- a/test/test.js +++ /dev/null @@ -1,86 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function does not perform bounds checking', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 4, 5, 1, 2 ]; - actual = take( x, indices ); - expected = [ void 0, void 0, 2, 3 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [] ), [], 'returns expected value' ); - t.end(); -}); From 4c2b0e8a183a43dfce82c2267492caf1a242c188 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Nov 2023 15:14:52 +0000 Subject: [PATCH 023/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 680d3a7..c9c0bc2 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-base-filled-by": "^0.1.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From a86222acb7ed19c7272d6b24ca6d2083a0b7445c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 2 Nov 2023 22:41:17 +0000 Subject: [PATCH 024/123] Remove files --- index.d.ts | 47 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6229 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 0e6bfce..0000000 --- a/index.d.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Takes element from an array. -* -* ## Notes -* -* - The function does **not** perform bounds checking. If an index is less than zero or greater than the maximum index of `x`, the value of the corresponding element in the output array is undefined. -* -* @param x - input array -* @param indices - list of element indices -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ] ); -* // returns [ 2, 4 ] -*/ -declare function take( x: Collection, indices: Collection ): Array; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d82d372..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 -/// -function r(r,t){var e,n;for(e=[],n=0;n - - - - - - Rollup Visualizer - - - -
- - - - - From eeed7af2ffe08aee233500008ac9d441fc9cd850 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 2 Nov 2023 22:43:46 +0000 Subject: [PATCH 025/123] 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 | 52 - benchmark/benchmark.length.js | 99 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 32 - docs/types/test.ts | 57 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 43 - lib/main.js | 51 - package.json | 60 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 86 - 43 files changed, 6202 insertions(+), 3808 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 benchmark/benchmark.length.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 (93%) 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 e3823b5..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-11-01T04:36:02.347Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 48e056d..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/take) 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 2e83b65..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/take) 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 c64025f..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: '11 23 * * 4' - - # 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 + + ```
@@ -143,7 +136,7 @@ console.log( y ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ae80e93..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 9bd4744..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = filledBy( len, discreteUniform( 0, 3 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fa94502..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 49ce5c8..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var a=o(function(v,s){ -function i(e,r){var u,t;for(u=[],t=0;t - List of element indices. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ] ) - [ 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index f9a8449..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ] ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ] ); // $ExpectError - take( true, [ 1, 3 ] ); // $ExpectError - take( false, [ 1, 3 ] ); // $ExpectError - take( null, [ 1, 3 ] ); // $ExpectError - take( void 0, [ 1, 3 ] ); // $ExpectError - take( {}, [ 1, 3 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1 ); // $ExpectError - take( [], true ); // $ExpectError - take( [], false ); // $ExpectError - take( [], null ); // $ExpectError - take( [], void 0 ); // $ExpectError - take( [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [], [] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 71354ad..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); - -// Take a random sample of elements from `x`: -var y = take( x, indices ); - -console.log( x ); -console.log( indices ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index 62d1d0d..0e6bfce 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..d82d372 --- /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 +/// +function r(r,t){var e,n;for(e=[],n=0;n=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -82,4 +28,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..26c2217 --- /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 fc93702..0000000 --- a/test/test.js +++ /dev/null @@ -1,86 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function does not perform bounds checking', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 4, 5, 1, 2 ]; - actual = take( x, indices ); - expected = [ void 0, void 0, 2, 3 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [] ), [], 'returns expected value' ); - t.end(); -}); From 9250c4f272a65ab8b948f8b7826c7099a4583632 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 23 Nov 2023 09:53:11 +0000 Subject: [PATCH 026/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index c743386..d341f0b 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-resolve-getter": "github:stdlib-js/array-base-resolve-getter#main", - "@stdlib/types": "^0.2.0" + "@stdlib/types": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.1.0", @@ -86,4 +87,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 3c9018fc55f7301f07752a94451d26cd9421ff4d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 23 Nov 2023 09:54:14 +0000 Subject: [PATCH 027/123] Remove files --- index.d.ts | 47 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6229 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 0e6bfce..0000000 --- a/index.d.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Takes element from an array. -* -* ## Notes -* -* - The function does **not** perform bounds checking. If an index is less than zero or greater than the maximum index of `x`, the value of the corresponding element in the output array is undefined. -* -* @param x - input array -* @param indices - list of element indices -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ] ); -* // returns [ 2, 4 ] -*/ -declare function take( x: Collection, indices: Collection ): Array; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d82d372..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 -/// -function r(r,t){var e,n;for(e=[],n=0;n - - - - - - Rollup Visualizer - - - -
- - - - - From d83da891291ad4e3ef98b3c9f51efc0faeba3567 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 23 Nov 2023 09:56:59 +0000 Subject: [PATCH 028/123] 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 | 52 - benchmark/benchmark.length.js | 99 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 32 - docs/types/test.ts | 57 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 43 - lib/main.js | 61 - package.json | 65 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 113 - 42 files changed, 6202 insertions(+), 3849 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 benchmark/benchmark.length.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 (93%) 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 48e056d..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/take) 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 2e83b65..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/take) 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 c64025f..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: '11 23 * * 4' - - # 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 + + ```
@@ -143,7 +136,7 @@ console.log( y ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ae80e93..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 9bd4744..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = filledBy( len, discreteUniform( 0, 3 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fa94502..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5b1e581..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var o=v(function(f,s){ -var i=require('@stdlib/array-base-resolve-getter/dist');function n(e,r){var a,u,t;for(a=i(e),u=[],t=0;t - List of element indices. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ] ) - [ 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index f9a8449..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ] ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ] ); // $ExpectError - take( true, [ 1, 3 ] ); // $ExpectError - take( false, [ 1, 3 ] ); // $ExpectError - take( null, [ 1, 3 ] ); // $ExpectError - take( void 0, [ 1, 3 ] ); // $ExpectError - take( {}, [ 1, 3 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1 ); // $ExpectError - take( [], true ); // $ExpectError - take( [], false ); // $ExpectError - take( [], null ); // $ExpectError - take( [], void 0 ); // $ExpectError - take( [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [], [] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 71354ad..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); - -// Take a random sample of elements from `x`: -var y = take( x, indices ); - -console.log( x ); -console.log( indices ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index 62d1d0d..0e6bfce 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..605af30 --- /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 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@esm/index.mjs";function r(r,t){var s,n,a;for(s=e(r),n=[],a=0;a=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -87,4 +28,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..61590e2 --- /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 741728f..0000000 --- a/test/test.js +++ /dev/null @@ -1,113 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices[ i ] ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function does not perform bounds checking', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 4, 5, 1, 2 ]; - actual = take( x, indices ); - expected = [ void 0, void 0, 2, 3 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [] ), [], 'returns expected value' ); - t.end(); -}); From 6e55a61e4482ea3d3b2371f3d8ed559331b8244a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 25 Nov 2023 21:43:08 +0000 Subject: [PATCH 029/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index a60b51f..f17e411 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-resolve-getter": "^0.1.0", - "@stdlib/types": "^0.2.0" + "@stdlib/types": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.1.0", @@ -86,4 +87,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 02f79419f49a93ebe6b90eca2a51ee3a99579b86 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 25 Nov 2023 21:43:30 +0000 Subject: [PATCH 030/123] Remove files --- index.d.ts | 47 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6229 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 0e6bfce..0000000 --- a/index.d.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Takes element from an array. -* -* ## Notes -* -* - The function does **not** perform bounds checking. If an index is less than zero or greater than the maximum index of `x`, the value of the corresponding element in the output array is undefined. -* -* @param x - input array -* @param indices - list of element indices -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ] ); -* // returns [ 2, 4 ] -*/ -declare function take( x: Collection, indices: Collection ): Array; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 605af30..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@esm/index.mjs";function r(r,t){var s,n,a;for(s=e(r),n=[],a=0;a - - - - - - Rollup Visualizer - - - -
- - - - - From 57db324e0668a80c456c0ddaf8621aca47ae2e11 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 25 Nov 2023 21:46:32 +0000 Subject: [PATCH 031/123] 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 | 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 | 52 - benchmark/benchmark.length.js | 99 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 32 - docs/types/test.ts | 57 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 43 - lib/main.js | 61 - package.json | 65 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 113 - 42 files changed, 6202 insertions(+), 3844 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 benchmark/benchmark.length.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 (93%) 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 48e056d..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/take) 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 2e83b65..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/take) 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 c64025f..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: '11 23 * * 4' - - # 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 + + ```
@@ -143,7 +136,7 @@ console.log( y ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ae80e93..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 9bd4744..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = filledBy( len, discreteUniform( 0, 3 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fa94502..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5b1e581..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var o=v(function(f,s){ -var i=require('@stdlib/array-base-resolve-getter/dist');function n(e,r){var a,u,t;for(a=i(e),u=[],t=0;t - List of element indices. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ] ) - [ 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index f9a8449..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ] ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ] ); // $ExpectError - take( true, [ 1, 3 ] ); // $ExpectError - take( false, [ 1, 3 ] ); // $ExpectError - take( null, [ 1, 3 ] ); // $ExpectError - take( void 0, [ 1, 3 ] ); // $ExpectError - take( {}, [ 1, 3 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1 ); // $ExpectError - take( [], true ); // $ExpectError - take( [], false ); // $ExpectError - take( [], null ); // $ExpectError - take( [], void 0 ); // $ExpectError - take( [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [], [] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 71354ad..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); - -// Take a random sample of elements from `x`: -var y = take( x, indices ); - -console.log( x ); -console.log( indices ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index 04c74e0..fa25fcc 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..c9087fe --- /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 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.1.0-esm/index.mjs";function r(r,t){var s,n,a;for(s=e(r),n=[],a=0;a=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -87,4 +28,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..0e00434 --- /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 741728f..0000000 --- a/test/test.js +++ /dev/null @@ -1,113 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices[ i ] ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function does not perform bounds checking', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 4, 5, 1, 2 ]; - actual = take( x, indices ); - expected = [ void 0, void 0, 2, 3 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [] ), [], 'returns expected value' ); - t.end(); -}); From eb967f1808f4a64da2544ce2661621a24e4aa884 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Dec 2023 14:00:15 +0000 Subject: [PATCH 032/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index a60b51f..f17e411 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-resolve-getter": "^0.1.0", - "@stdlib/types": "^0.2.0" + "@stdlib/types": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.1.0", @@ -86,4 +87,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 5c1661d707ad1d2e171ec304b21a47db6f45d34b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 12:21:15 +0000 Subject: [PATCH 033/123] Remove files --- index.d.ts | 47 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6229 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 fa25fcc..0000000 --- a/index.d.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Takes element from an array. -* -* ## Notes -* -* - The function does **not** perform bounds checking. If an index is less than zero or greater than the maximum index of `x`, the value of the corresponding element in the output array is undefined. -* -* @param x - input array -* @param indices - list of element indices -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ] ); -* // returns [ 2, 4 ] -*/ -declare function take( x: Collection, indices: Collection ): Array; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index c9087fe..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.1.0-esm/index.mjs";function r(r,t){var s,n,a;for(s=e(r),n=[],a=0;a - - - - - - Rollup Visualizer - - - -
- - - - - From a9721988bc4494625d57ca5f603048311d52ebc3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 12:23:55 +0000 Subject: [PATCH 034/123] 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 | 52 - benchmark/benchmark.length.js | 99 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 32 - docs/types/test.ts | 57 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 43 - lib/main.js | 61 - package.json | 65 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 113 - 43 files changed, 6202 insertions(+), 3845 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 benchmark/benchmark.length.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 (93%) 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 c448057..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-12-01T05:54:25.050Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 48e056d..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/take) 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 2e83b65..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/take) 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 c64025f..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: '11 23 * * 4' - - # 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 + + ```
@@ -143,7 +136,7 @@ console.log( y ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ae80e93..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 9bd4744..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = filledBy( len, discreteUniform( 0, 3 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fa94502..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5b1e581..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var o=v(function(f,s){ -var i=require('@stdlib/array-base-resolve-getter/dist');function n(e,r){var a,u,t;for(a=i(e),u=[],t=0;t - List of element indices. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ] ) - [ 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index f9a8449..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ] ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ] ); // $ExpectError - take( true, [ 1, 3 ] ); // $ExpectError - take( false, [ 1, 3 ] ); // $ExpectError - take( null, [ 1, 3 ] ); // $ExpectError - take( void 0, [ 1, 3 ] ); // $ExpectError - take( {}, [ 1, 3 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1 ); // $ExpectError - take( [], true ); // $ExpectError - take( [], false ); // $ExpectError - take( [], null ); // $ExpectError - take( [], void 0 ); // $ExpectError - take( [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [], [] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 71354ad..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); - -// Take a random sample of elements from `x`: -var y = take( x, indices ); - -console.log( x ); -console.log( indices ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index 04c74e0..fa25fcc 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..c9087fe --- /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 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.1.0-esm/index.mjs";function r(r,t){var s,n,a;for(s=e(r),n=[],a=0;a=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -87,4 +28,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..810b555 --- /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 741728f..0000000 --- a/test/test.js +++ /dev/null @@ -1,113 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices[ i ] ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function does not perform bounds checking', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 4, 5, 1, 2 ]; - actual = take( x, indices ); - expected = [ void 0, void 0, 2, 3 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [] ), [], 'returns expected value' ); - t.end(); -}); From acdb1ccf2ccdd76d0189c4749bc00baf1169d867 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 08:20:16 +0000 Subject: [PATCH 035/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index b792874..84e4651 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-resolve-getter": "^0.1.0", - "@stdlib/types": "^0.2.0" + "@stdlib/types": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.1.0", @@ -86,4 +87,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From bbdb20ac79d0a11c39b7d01d1543b9d3da9d30f9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 14:59:51 +0000 Subject: [PATCH 036/123] Remove files --- index.d.ts | 47 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6229 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 fa25fcc..0000000 --- a/index.d.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Takes element from an array. -* -* ## Notes -* -* - The function does **not** perform bounds checking. If an index is less than zero or greater than the maximum index of `x`, the value of the corresponding element in the output array is undefined. -* -* @param x - input array -* @param indices - list of element indices -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ] ); -* // returns [ 2, 4 ] -*/ -declare function take( x: Collection, indices: Collection ): Array; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index c9087fe..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.1.0-esm/index.mjs";function r(r,t){var s,n,a;for(s=e(r),n=[],a=0;a - - - - - - Rollup Visualizer - - - -
- - - - - From 0aaaf7e47e50db7e99208f76aafae0664bdc3475 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 15:00:21 +0000 Subject: [PATCH 037/123] 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 | 52 - benchmark/benchmark.length.js | 99 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 32 - docs/types/test.ts | 57 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 43 - lib/main.js | 61 - package.json | 65 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 113 - 44 files changed, 6202 insertions(+), 3851 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 benchmark/benchmark.length.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 (93%) 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 a8088a1..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-01-01T05:23:08.163Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 48e056d..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/take) 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 2e83b65..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/take) 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 8c5bdc1..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: '11 23 * * 4' - - # 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 + + ```
@@ -143,7 +136,7 @@ console.log( y ); ## 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]. 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 c1ebb0e..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index cec6eb4..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = filledBy( len, discreteUniform( 0, 3 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fa94502..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5b1e581..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var o=v(function(f,s){ -var i=require('@stdlib/array-base-resolve-getter/dist');function n(e,r){var a,u,t;for(a=i(e),u=[],t=0;t - List of element indices. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ] ) - [ 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index f9a8449..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ] ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ] ); // $ExpectError - take( true, [ 1, 3 ] ); // $ExpectError - take( false, [ 1, 3 ] ); // $ExpectError - take( null, [ 1, 3 ] ); // $ExpectError - take( void 0, [ 1, 3 ] ); // $ExpectError - take( {}, [ 1, 3 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1 ); // $ExpectError - take( [], true ); // $ExpectError - take( [], false ); // $ExpectError - take( [], null ); // $ExpectError - take( [], void 0 ); // $ExpectError - take( [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [], [] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 71354ad..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); - -// Take a random sample of elements from `x`: -var y = take( x, indices ); - -console.log( x ); -console.log( indices ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index 04c74e0..fa25fcc 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..654073b --- /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 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.1.0-esm/index.mjs";function r(r,t){var s,n,a;for(s=e(r),n=[],a=0;a=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -87,4 +28,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..12c06bc --- /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 741728f..0000000 --- a/test/test.js +++ /dev/null @@ -1,113 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices[ i ] ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function does not perform bounds checking', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 4, 5, 1, 2 ]; - actual = take( x, indices ); - expected = [ void 0, void 0, 2, 3 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [] ), [], 'returns expected value' ); - t.end(); -}); From fb366d6a7da17d47981c8df6bf7c4a11d44d0aaf Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 08:54:50 +0000 Subject: [PATCH 038/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index b792874..84e4651 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-resolve-getter": "^0.1.0", - "@stdlib/types": "^0.2.0" + "@stdlib/types": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.1.0", @@ -86,4 +87,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 391778f77be58d6a2955fb77af41390fea6cac59 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 14:18:28 +0000 Subject: [PATCH 039/123] Remove files --- index.d.ts | 47 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6229 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 fa25fcc..0000000 --- a/index.d.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Takes element from an array. -* -* ## Notes -* -* - The function does **not** perform bounds checking. If an index is less than zero or greater than the maximum index of `x`, the value of the corresponding element in the output array is undefined. -* -* @param x - input array -* @param indices - list of element indices -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ] ); -* // returns [ 2, 4 ] -*/ -declare function take( x: Collection, indices: Collection ): Array; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 654073b..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.1.0-esm/index.mjs";function r(r,t){var s,n,a;for(s=e(r),n=[],a=0;a - - - - - - Rollup Visualizer - - - -
- - - - - From a325571fec0eb9e6d9b7e1a3eca383b710f9bf7a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 14:18:55 +0000 Subject: [PATCH 040/123] 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 | 52 - benchmark/benchmark.length.js | 99 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 32 - docs/types/test.ts | 57 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 43 - lib/main.js | 61 - package.json | 65 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 113 - 44 files changed, 6202 insertions(+), 3856 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 benchmark/benchmark.length.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 (93%) 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 dac76d6..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-02-01T06:14:52.758Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 48e056d..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/take) 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 2e83b65..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/take) 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 8c5bdc1..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: '11 23 * * 4' - - # 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 + + ```
@@ -145,7 +136,7 @@ console.log( y ); ## 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]. 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 c1ebb0e..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index cec6eb4..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = filledBy( len, discreteUniform( 0, 3 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5b1e581..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var o=v(function(f,s){ -var i=require('@stdlib/array-base-resolve-getter/dist');function n(e,r){var a,u,t;for(a=i(e),u=[],t=0;t - List of element indices. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ] ) - [ 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index f9a8449..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ] ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ] ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ] ); // $ExpectError - take( true, [ 1, 3 ] ); // $ExpectError - take( false, [ 1, 3 ] ); // $ExpectError - take( null, [ 1, 3 ] ); // $ExpectError - take( void 0, [ 1, 3 ] ); // $ExpectError - take( {}, [ 1, 3 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1 ); // $ExpectError - take( [], true ); // $ExpectError - take( [], false ); // $ExpectError - take( [], null ); // $ExpectError - take( [], void 0 ); // $ExpectError - take( [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [], [] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 71354ad..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); - -// Take a random sample of elements from `x`: -var y = take( x, indices ); - -console.log( x ); -console.log( indices ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index 04c74e0..fa25fcc 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..654073b --- /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 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.1.0-esm/index.mjs";function r(r,t){var s,n,a;for(s=e(r),n=[],a=0;a=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -87,4 +28,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..183d1b0 --- /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 741728f..0000000 --- a/test/test.js +++ /dev/null @@ -1,113 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices[ i ] ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function does not perform bounds checking', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 4, 5, 1, 2 ]; - actual = take( x, indices ); - expected = [ void 0, void 0, 2, 3 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [] ), [], 'returns expected value' ); - t.end(); -}); From 256741a55fd7fdb01c05507cf00eec68f7fa9a0b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 02:41:22 +0000 Subject: [PATCH 041/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index ee5690f..884714b 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.0", "@stdlib/strided-base-reinterpret-complex": "github:stdlib-js/strided-base-reinterpret-complex#main", "@stdlib/types": "^0.3.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.2.0" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.1.0", @@ -98,4 +99,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 1bfb974bca7ec23663b4cdf73e0d933695e95ca3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:21:23 +0000 Subject: [PATCH 042/123] Remove files --- index.d.ts | 47 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6229 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 fa25fcc..0000000 --- a/index.d.ts +++ /dev/null @@ -1,47 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Takes element from an array. -* -* ## Notes -* -* - The function does **not** perform bounds checking. If an index is less than zero or greater than the maximum index of `x`, the value of the corresponding element in the output array is undefined. -* -* @param x - input array -* @param indices - list of element indices -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ] ); -* // returns [ 2, 4 ] -*/ -declare function take( x: Collection, indices: Collection ): Array; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 654073b..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.1.0-esm/index.mjs";function r(r,t){var s,n,a;for(s=e(r),n=[],a=0;a - - - - - - Rollup Visualizer - - - -
- - - - - From bc5e3fec84be73d9895ebecf3502c0c2c4e44971 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:22:58 +0000 Subject: [PATCH 043/123] 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 | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 106 - benchmark/benchmark.js | 52 - benchmark/benchmark.length.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 250 - lib/index.js | 64 - lib/main.js | 75 - package.json | 77 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 607 -- test/test.js | 176 - 46 files changed, 6209 insertions(+), 5108 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.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 48e056d..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/take) 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 2e83b65..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/take) 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 3e6bef1..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: '11 23 * * 4' - - # 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 + + ```
@@ -173,7 +170,7 @@ console.log( y ); ## 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]. @@ -236,7 +233,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 4f84813..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff5aee8..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index f873b3a..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 03405d7..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var I=y(function(F,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,r,c){var t,s,i,o,v,a,n;for(s=j(e),i=j(r),t=G(c),v=e.length-1,o=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA2BA,SAASkB,EAAQrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK1B,EAAkBI,CAAE,EACzBQ,EAAKZ,EAAkBK,CAAQ,EAC/BsB,EAAK3B,EAAkBO,CAAI,EAE1BmB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF5B,EAAmB2B,EAAG,KAAM,GAC5B3B,EAAmB4B,EAAG,KAAM,GAE5BL,EAASrB,EAAaG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,IAERQ,EAAWW,EAAId,EAAIN,EAAMqB,EAAInB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAT,EAAO,QAAU2B,ICtMjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index e4575ea..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); - -console.log( x ); -console.log( indices ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 2c19cc6..1cf5274 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..5bb3053 --- /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 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.0-esm/index.mjs";import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.1.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@esm/index.mjs";function a(e,r,n){var o,a,i,d,l,c,m;for(a=s(e),i=s(r),o=t(n),l=e.length-1,d=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;4oBA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CCqJA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA1EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CA6CGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,IA1IV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA4B,EACAP,EACAQ,EACA5B,EACAC,EACA4B,EACA1B,EACAW,EACAV,EAmBJ,IAhBAuB,EAAQ/B,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBK,EAAQ1B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BK,EAAO3B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAMwB,EAAMnB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9ByB,EAAMD,EAAOd,EAAId,EAAM2B,EADnB5B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAyGEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IA7LT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CA0KCmB,CAASlC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CC1LA6B,EAAAC,EAAA,SAAAtB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 4a9114e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,250 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {IntegerArray} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 884714b..20915b5 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.0", "description": "Take elements from an array.", "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,54 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.0", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.0", - "@stdlib/array-base-resolve-getter": "^0.2.0", - "@stdlib/ndarray-base-ind": "^0.2.0", - "@stdlib/strided-base-reinterpret-complex": "github:stdlib-js/strided-base-reinterpret-complex#main", - "@stdlib/types": "^0.3.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.1.0", - "@stdlib/array-base-linspace": "^0.2.0", - "@stdlib/array-base-to-accessor-array": "^0.1.0", - "@stdlib/array-base-zero-to": "^0.1.0", - "@stdlib/array-complex128": "^0.1.0", - "@stdlib/array-complex64": "^0.1.0", - "@stdlib/array-float64": "^0.2.0", - "@stdlib/array-zeros": "^0.1.0", - "@stdlib/assert-is-array": "^0.2.0", - "@stdlib/assert-is-complex64": "^0.2.0", - "@stdlib/assert-is-same-complex128array": "^0.1.0", - "@stdlib/assert-is-same-complex64array": "^0.1.0", - "@stdlib/complex-imagf": "^0.2.0", - "@stdlib/complex-realf": "^0.2.0", - "@stdlib/math-base-special-pow": "^0.2.0", - "@stdlib/random-array-discrete-uniform": "^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", - "@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", "utilities", @@ -99,4 +28,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..0509ee7 --- /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.assign.js b/test/test.assign.js deleted file mode 100644 index 1084c39..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,607 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index b9c859c..0000000 --- a/test/test.js +++ /dev/null @@ -1,176 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 6009c3c3d4eaa1cc925b7ece13bb90ba11730d32 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:50:44 +0000 Subject: [PATCH 044/123] Update README.md for ESM bundle v0.2.0 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 826bcca..f92c5dd 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.2.0-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.2.0-esm/index.mjs'; ``` #### take( x, indices, mode ) @@ -128,7 +128,7 @@ The function supports the following parameters: import filledBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs'; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@esm/index.mjs'; import linspace from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-linspace@esm/index.mjs'; -import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.2.0-esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From bcec9cfe514b9b472cb50e5ea0295f8781addf29 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:50:45 +0000 Subject: [PATCH 045/123] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f92c5dd..a963b6a 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,11 @@ limitations under the License. ## Usage +```javascript +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@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-take/tags). For example, + ```javascript import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.2.0-esm/index.mjs'; ``` @@ -48,7 +53,7 @@ import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.2.0-e You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.2.0-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; ``` #### take( x, indices, mode ) @@ -128,7 +133,7 @@ The function supports the following parameters: import filledBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs'; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@esm/index.mjs'; import linspace from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-linspace@esm/index.mjs'; -import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.2.0-esm/index.mjs'; +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From 052c5b349fcf4cf130384b5fb0501ccf9be16b1e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 18 Feb 2024 08:12:31 +0000 Subject: [PATCH 046/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4848798..d8f7daa 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.0", "@stdlib/strided-base-reinterpret-complex": "github:stdlib-js/strided-base-reinterpret-complex#main", "@stdlib/types": "^0.3.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.2.0" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.2.0", @@ -98,4 +99,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From adde8f40103613bdaf92ec63b73eebe08276a451 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 18 Feb 2024 08:12:57 +0000 Subject: [PATCH 047/123] Remove files --- index.d.ts | 429 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6611 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 1cf5274..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 5bb3053..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.0-esm/index.mjs";import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.1.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@esm/index.mjs";function a(e,r,n){var o,a,i,d,l,c,m;for(a=s(e),i=s(r),o=t(n),l=e.length-1,d=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;4oBA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CCqJA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA1EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CA6CGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,IA1IV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA4B,EACAP,EACAQ,EACA5B,EACAC,EACA4B,EACA1B,EACAW,EACAV,EAmBJ,IAhBAuB,EAAQ/B,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBK,EAAQ1B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BK,EAAO3B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAMwB,EAAMnB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9ByB,EAAMD,EAAOd,EAAId,EAAM2B,EADnB5B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAyGEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IA7LT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CA0KCmB,CAASlC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CC1LA6B,EAAAC,EAAA,SAAAtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 0509ee7..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 314f870e01f8daf82174d85b6a8d1faa7e3909f9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 18 Feb 2024 08:14:44 +0000 Subject: [PATCH 048/123] 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 | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 106 - benchmark/benchmark.js | 52 - benchmark/benchmark.length.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 250 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 77 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 607 --- test/test.js | 176 - 46 files changed, 4874 insertions(+), 5102 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.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 48e056d..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -173,7 +170,7 @@ console.log( y ); ## 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]. @@ -236,7 +233,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 4f84813..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff5aee8..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index f873b3a..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 03405d7..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var I=y(function(F,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,r,c){var t,s,i,o,v,a,n;for(s=j(e),i=j(r),t=G(c),v=e.length-1,o=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA2BA,SAASkB,EAAQrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK1B,EAAkBI,CAAE,EACzBQ,EAAKZ,EAAkBK,CAAQ,EAC/BsB,EAAK3B,EAAkBO,CAAI,EAE1BmB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF5B,EAAmB2B,EAAG,KAAM,GAC5B3B,EAAmB4B,EAAG,KAAM,GAE5BL,EAASrB,EAAaG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,IAERQ,EAAWW,EAAId,EAAIN,EAAMqB,EAAInB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAT,EAAO,QAAU2B,ICtMjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index e4575ea..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); - -console.log( x ); -console.log( indices ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 2c19cc6..1cf5274 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..cc10a8a --- /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 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.0-esm/index.mjs";import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@esm/index.mjs";function a(e,r,n){var o,a,i,d,l,c,m;for(a=s(e),i=s(r),o=t(n),l=e.length-1,d=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;4oBA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CCqJA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA1EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CA6CGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,IA1IV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA4B,EACAP,EACAQ,EACA5B,EACAC,EACA4B,EACA1B,EACAW,EACAV,EAmBJ,IAhBAuB,EAAQ/B,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBK,EAAQ1B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BK,EAAO3B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAMwB,EAAMnB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9ByB,EAAMD,EAAOd,EAAId,EAAM2B,EADnB5B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAyGEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IA7LT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CA0KCmB,CAASlC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CC1LA6B,EAAAC,EAAA,SAAAtB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index cbc649e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,250 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index d8f7daa..20915b5 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.0", "description": "Take elements from an array.", "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,54 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.0", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.0", - "@stdlib/array-base-resolve-getter": "^0.2.0", - "@stdlib/ndarray-base-ind": "^0.2.0", - "@stdlib/strided-base-reinterpret-complex": "github:stdlib-js/strided-base-reinterpret-complex#main", - "@stdlib/types": "^0.3.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.0", - "@stdlib/array-base-linspace": "^0.2.0", - "@stdlib/array-base-to-accessor-array": "^0.2.0", - "@stdlib/array-base-zero-to": "^0.2.0", - "@stdlib/array-complex128": "^0.2.0", - "@stdlib/array-complex64": "^0.2.0", - "@stdlib/array-float64": "^0.2.0", - "@stdlib/array-zeros": "^0.2.0", - "@stdlib/assert-is-array": "^0.2.0", - "@stdlib/assert-is-complex64": "^0.2.0", - "@stdlib/assert-is-same-complex128array": "^0.2.0", - "@stdlib/assert-is-same-complex64array": "^0.2.0", - "@stdlib/complex-imagf": "^0.2.0", - "@stdlib/complex-realf": "^0.2.0", - "@stdlib/math-base-special-pow": "^0.2.0", - "@stdlib/random-array-discrete-uniform": "^0.2.0", - "@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.0" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -99,4 +28,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..2fb4ff6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 1084c39..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,607 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index b9c859c..0000000 --- a/test/test.js +++ /dev/null @@ -1,176 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 8525239ffaa730c2e416817878ac75aa755e1355 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 20 Feb 2024 01:42:55 +0000 Subject: [PATCH 049/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 6b2a9cf..4f5766f 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.0", "@stdlib/strided-base-reinterpret-complex": "github:stdlib-js/strided-base-reinterpret-complex#main", "@stdlib/types": "^0.3.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.2.0" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.2.0", @@ -100,4 +101,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 02b4cbfddd9384e9e4656089bb295aa7f81b27fb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 20 Feb 2024 01:43:20 +0000 Subject: [PATCH 050/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 1cf5274..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index cc10a8a..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.0-esm/index.mjs";import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@esm/index.mjs";function a(e,r,n){var o,a,i,d,l,c,m;for(a=s(e),i=s(r),o=t(n),l=e.length-1,d=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;4oBA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CCqJA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA1EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CA6CGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,IA1IV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA4B,EACAP,EACAQ,EACA5B,EACAC,EACA4B,EACA1B,EACAW,EACAV,EAmBJ,IAhBAuB,EAAQ/B,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBK,EAAQ1B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BK,EAAO3B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAMwB,EAAMnB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9ByB,EAAMD,EAAOd,EAAId,EAAM2B,EADnB5B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAyGEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IA7LT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CA0KCmB,CAASlC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CC1LA6B,EAAAC,EAAA,SAAAtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2fb4ff6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 884d2f60be5b056c4c53b69aa85656dcd62f9a83 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 20 Feb 2024 01:45:17 +0000 Subject: [PATCH 051/123] 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 | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 106 - benchmark/benchmark.js | 52 - benchmark/benchmark.length.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 250 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 79 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 607 --- test/test.js | 41 - test/test.main.js | 176 - 47 files changed, 4874 insertions(+), 5144 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 48e056d..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 4f84813..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff5aee8..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index f873b3a..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 03405d7..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var I=y(function(F,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,r,c){var t,s,i,o,v,a,n;for(s=j(e),i=j(r),t=G(c),v=e.length-1,o=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA2BA,SAASkB,EAAQrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK1B,EAAkBI,CAAE,EACzBQ,EAAKZ,EAAkBK,CAAQ,EAC/BsB,EAAK3B,EAAkBO,CAAI,EAE1BmB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF5B,EAAmB2B,EAAG,KAAM,GAC5B3B,EAAmB4B,EAAG,KAAM,GAE5BL,EAASrB,EAAaG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,IAERQ,EAAWW,EAAId,EAAIN,EAAMqB,EAAInB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAT,EAAO,QAAU2B,ICtMjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 2c19cc6..1cf5274 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..cc10a8a --- /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 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.0-esm/index.mjs";import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@esm/index.mjs";function a(e,r,n){var o,a,i,d,l,c,m;for(a=s(e),i=s(r),o=t(n),l=e.length-1,d=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;4oBA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CCqJA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA1EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CA6CGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,IA1IV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA4B,EACAP,EACAQ,EACA5B,EACAC,EACA4B,EACA1B,EACAW,EACAV,EAmBJ,IAhBAuB,EAAQ/B,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBK,EAAQ1B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BK,EAAO3B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAMwB,EAAMnB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9ByB,EAAMD,EAAOd,EAAId,EAAM2B,EADnB5B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAyGEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IA7LT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CA0KCmB,CAASlC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CC1LA6B,EAAAC,EAAA,SAAAtB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index cbc649e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,250 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 4f5766f..20915b5 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.0", "description": "Take elements from an array.", "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,56 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.0", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.0", - "@stdlib/array-base-resolve-getter": "^0.2.0", - "@stdlib/ndarray-base-ind": "^0.2.0", - "@stdlib/strided-base-reinterpret-complex": "github:stdlib-js/strided-base-reinterpret-complex#main", - "@stdlib/types": "^0.3.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.0", - "@stdlib/array-base-linspace": "^0.2.0", - "@stdlib/array-base-to-accessor-array": "^0.2.0", - "@stdlib/array-base-zero-to": "^0.2.0", - "@stdlib/array-complex128": "^0.2.0", - "@stdlib/array-complex64": "^0.2.0", - "@stdlib/array-float64": "^0.2.0", - "@stdlib/array-zeros": "^0.2.0", - "@stdlib/assert-has-own-property": "^0.2.0", - "@stdlib/assert-is-array": "^0.2.0", - "@stdlib/assert-is-complex64": "^0.2.0", - "@stdlib/assert-is-method": "^0.2.0", - "@stdlib/assert-is-same-complex128array": "^0.2.0", - "@stdlib/assert-is-same-complex64array": "^0.2.0", - "@stdlib/complex-imagf": "^0.2.0", - "@stdlib/complex-realf": "^0.2.0", - "@stdlib/math-base-special-pow": "^0.2.0", - "@stdlib/random-array-discrete-uniform": "^0.2.0", - "@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.0" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -101,4 +28,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..2fb4ff6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 1084c39..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,607 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b9c859c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,176 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 91baa774c48ceed58e91ce0ed42ec2422dddbc07 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 20:56:38 +0000 Subject: [PATCH 052/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index ea12893..401e5f1 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.1", "@stdlib/strided-base-reinterpret-complex": "^0.1.1", "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.2.1", @@ -100,4 +101,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 934ca2a2e2bfcec3febcdaa563e0efa6f3039b90 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 22:17:11 +0000 Subject: [PATCH 053/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 1cf5274..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index cc10a8a..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.0-esm/index.mjs";import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@esm/index.mjs";function a(e,r,n){var o,a,i,d,l,c,m;for(a=s(e),i=s(r),o=t(n),l=e.length-1,d=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;4oBA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CCqJA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA1EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CA6CGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,IA1IV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA4B,EACAP,EACAQ,EACA5B,EACAC,EACA4B,EACA1B,EACAW,EACAV,EAmBJ,IAhBAuB,EAAQ/B,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBK,EAAQ1B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BK,EAAO3B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAMwB,EAAMnB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9ByB,EAAMD,EAAOd,EAAId,EAAM2B,EADnB5B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAyGEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IA7LT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CA0KCmB,CAASlC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CC1LA6B,EAAAC,EAAA,SAAAtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2fb4ff6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From fa85d3fb00376a172bcf4b73ed05da8ece7f8edc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 22:17:44 +0000 Subject: [PATCH 054/123] 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 | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 106 - benchmark/benchmark.js | 52 - benchmark/benchmark.length.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 250 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 79 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 607 --- test/test.js | 41 - test/test.main.js | 176 - 47 files changed, 4874 insertions(+), 5144 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 48e056d..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 4f84813..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff5aee8..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index f873b3a..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 03405d7..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var I=y(function(F,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,r,c){var t,s,i,o,v,a,n;for(s=j(e),i=j(r),t=G(c),v=e.length-1,o=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA2BA,SAASkB,EAAQrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK1B,EAAkBI,CAAE,EACzBQ,EAAKZ,EAAkBK,CAAQ,EAC/BsB,EAAK3B,EAAkBO,CAAI,EAE1BmB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF5B,EAAmB2B,EAAG,KAAM,GAC5B3B,EAAmB4B,EAAG,KAAM,GAE5BL,EAASrB,EAAaG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,IAERQ,EAAWW,EAAId,EAAIN,EAAMqB,EAAInB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAT,EAAO,QAAU2B,ICtMjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 2c19cc6..1cf5274 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..adcecb3 --- /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 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n){var o,a,i,d,l,c,m;for(a=s(e),i=s(r),o=t(n),l=e.length-1,d=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;mpBA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CCqJA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA1EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CA6CGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,IA1IV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA4B,EACAP,EACAQ,EACA5B,EACAC,EACA4B,EACA1B,EACAW,EACAV,EAmBJ,IAhBAuB,EAAQ/B,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBK,EAAQ1B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BK,EAAO3B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAMwB,EAAMnB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9ByB,EAAMD,EAAOd,EAAId,EAAM2B,EADnB5B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAyGEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IA7LT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CA0KCmB,CAASlC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CC1LA6B,EAAAC,EAAA,SAAAtB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index cbc649e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,250 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 401e5f1..3d80912 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Take elements from an array.", "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,56 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1", - "@stdlib/array-base-resolve-getter": "^0.2.0", - "@stdlib/ndarray-base-ind": "^0.2.1", - "@stdlib/strided-base-reinterpret-complex": "^0.1.1", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.1", - "@stdlib/array-base-linspace": "^0.2.1", - "@stdlib/array-base-to-accessor-array": "^0.2.0", - "@stdlib/array-base-zero-to": "^0.2.0", - "@stdlib/array-complex128": "^0.2.0", - "@stdlib/array-complex64": "^0.2.0", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-zeros": "^0.2.0", - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-complex64": "^0.2.1", - "@stdlib/assert-is-method": "^0.2.1", - "@stdlib/assert-is-same-complex128array": "^0.2.0", - "@stdlib/assert-is-same-complex64array": "^0.2.0", - "@stdlib/complex-imagf": "^0.2.1", - "@stdlib/complex-realf": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-array-discrete-uniform": "^0.2.0", - "@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", "utilities", @@ -101,4 +28,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..a8b374b --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 1084c39..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,607 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b9c859c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,176 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From b32cdc5bf84927928084942272c2f70b704d7678 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 22:33:25 +0000 Subject: [PATCH 055/123] Update README.md for ESM bundle v0.2.1 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9aa8595..23f4686 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.2.1-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.2.1-esm/index.mjs'; ``` #### take( x, indices, mode ) @@ -128,7 +128,7 @@ The function supports the following parameters: import filledBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs'; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@esm/index.mjs'; import linspace from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-linspace@esm/index.mjs'; -import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.2.1-esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From 72feae04cca5a1752e2d4b22853d1dff6887d704 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 22:33:25 +0000 Subject: [PATCH 056/123] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 23f4686..384faa5 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,11 @@ limitations under the License. ## Usage +```javascript +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@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-take/tags). For example, + ```javascript import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.2.1-esm/index.mjs'; ``` @@ -48,7 +53,7 @@ import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.2.1-e You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.2.1-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; ``` #### take( x, indices, mode ) @@ -128,7 +133,7 @@ The function supports the following parameters: import filledBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs'; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@esm/index.mjs'; import linspace from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-linspace@esm/index.mjs'; -import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.2.1-esm/index.mjs'; +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From dd4e95ec9c6d5f36b698fac80e26bd344fb68f6f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 08:28:37 +0000 Subject: [PATCH 057/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index ead268d..3ef40ec 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.1", "@stdlib/strided-base-reinterpret-complex": "^0.1.1", "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.2.1", @@ -100,4 +101,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 1e0fddc8e9792fb09aca2941db00fcd91199db88 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 14:03:23 +0000 Subject: [PATCH 058/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 1cf5274..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index adcecb3..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n){var o,a,i,d,l,c,m;for(a=s(e),i=s(r),o=t(n),l=e.length-1,d=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;mpBA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CCqJA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA1EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CA6CGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,IA1IV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA4B,EACAP,EACAQ,EACA5B,EACAC,EACA4B,EACA1B,EACAW,EACAV,EAmBJ,IAhBAuB,EAAQ/B,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBK,EAAQ1B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BK,EAAO3B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAMwB,EAAMnB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9ByB,EAAMD,EAAOd,EAAId,EAAM2B,EADnB5B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAyGEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IA7LT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CA0KCmB,CAASlC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CC1LA6B,EAAAC,EAAA,SAAAtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a8b374b..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 6323e7da6bab67e7f6f6169a12f918b4568735c5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 14:03:41 +0000 Subject: [PATCH 059/123] 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 | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 106 - benchmark/benchmark.js | 52 - benchmark/benchmark.length.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 250 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 79 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 607 --- test/test.js | 41 - test/test.main.js | 176 - 48 files changed, 4874 insertions(+), 5149 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 3712b07..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-04-01T05:52:29.548Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 48e056d..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 4f84813..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff5aee8..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index f873b3a..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 03405d7..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var I=y(function(F,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,r,c){var t,s,i,o,v,a,n;for(s=j(e),i=j(r),t=G(c),v=e.length-1,o=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA2BA,SAASkB,EAAQrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK1B,EAAkBI,CAAE,EACzBQ,EAAKZ,EAAkBK,CAAQ,EAC/BsB,EAAK3B,EAAkBO,CAAI,EAE1BmB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF5B,EAAmB2B,EAAG,KAAM,GAC5B3B,EAAmB4B,EAAG,KAAM,GAE5BL,EAASrB,EAAaG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,IAERQ,EAAWW,EAAId,EAAIN,EAAMqB,EAAInB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAT,EAAO,QAAU2B,ICtMjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 2c19cc6..1cf5274 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..adcecb3 --- /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 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n){var o,a,i,d,l,c,m;for(a=s(e),i=s(r),o=t(n),l=e.length-1,d=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;mpBA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CCqJA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA1EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CA6CGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,IA1IV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA4B,EACAP,EACAQ,EACA5B,EACAC,EACA4B,EACA1B,EACAW,EACAV,EAmBJ,IAhBAuB,EAAQ/B,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBK,EAAQ1B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BK,EAAO3B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAMwB,EAAMnB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9ByB,EAAMD,EAAOd,EAAId,EAAM2B,EADnB5B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAyGEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IA7LT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CA0KCmB,CAASlC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CC1LA6B,EAAAC,EAAA,SAAAtB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index cbc649e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,250 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 3ef40ec..3d80912 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Take elements from an array.", "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,56 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1", - "@stdlib/array-base-resolve-getter": "^0.2.1", - "@stdlib/ndarray-base-ind": "^0.2.1", - "@stdlib/strided-base-reinterpret-complex": "^0.1.1", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.1", - "@stdlib/array-base-linspace": "^0.2.1", - "@stdlib/array-base-to-accessor-array": "^0.2.1", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-complex128": "^0.2.1", - "@stdlib/array-complex64": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-zeros": "^0.2.1", - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-complex64": "^0.2.1", - "@stdlib/assert-is-method": "^0.2.1", - "@stdlib/assert-is-same-complex128array": "^0.2.1", - "@stdlib/assert-is-same-complex64array": "^0.2.1", - "@stdlib/complex-imagf": "^0.2.1", - "@stdlib/complex-realf": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-array-discrete-uniform": "^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", "utilities", @@ -101,4 +28,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..a8b374b --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 1084c39..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,607 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b9c859c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,176 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 7eaf5c26a1f3fedeb2f9aeea002cc793c0a3f899 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 04:37:01 +0000 Subject: [PATCH 060/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index ead268d..3ef40ec 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.1", "@stdlib/strided-base-reinterpret-complex": "^0.1.1", "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.2.1", @@ -100,4 +101,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From c9dddcfe1f8a658e6891074aee9f3ee8e81a640c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 10:18:23 +0000 Subject: [PATCH 061/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 1cf5274..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index adcecb3..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n){var o,a,i,d,l,c,m;for(a=s(e),i=s(r),o=t(n),l=e.length-1,d=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;mpBA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CCqJA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA1EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CA6CGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,IA1IV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA4B,EACAP,EACAQ,EACA5B,EACAC,EACA4B,EACA1B,EACAW,EACAV,EAmBJ,IAhBAuB,EAAQ/B,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBK,EAAQ1B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BK,EAAO3B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAMwB,EAAMnB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9ByB,EAAMD,EAAOd,EAAId,EAAM2B,EADnB5B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAyGEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IA7LT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CA0KCmB,CAASlC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CC1LA6B,EAAAC,EAAA,SAAAtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a8b374b..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 57cc4ce54a833d68b24815c55a7c50408f383efe Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 10:18:53 +0000 Subject: [PATCH 062/123] 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 | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 106 - benchmark/benchmark.js | 52 - benchmark/benchmark.length.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 250 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 79 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 607 --- test/test.js | 41 - test/test.main.js | 176 - 47 files changed, 4874 insertions(+), 5150 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 48e056d..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 4f84813..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff5aee8..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index f873b3a..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 03405d7..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var I=y(function(F,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,r,c){var t,s,i,o,v,a,n;for(s=j(e),i=j(r),t=G(c),v=e.length-1,o=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA2BA,SAASkB,EAAQrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK1B,EAAkBI,CAAE,EACzBQ,EAAKZ,EAAkBK,CAAQ,EAC/BsB,EAAK3B,EAAkBO,CAAI,EAE1BmB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF5B,EAAmB2B,EAAG,KAAM,GAC5B3B,EAAmB4B,EAAG,KAAM,GAE5BL,EAASrB,EAAaG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,IAERQ,EAAWW,EAAId,EAAIN,EAAMqB,EAAInB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAT,EAAO,QAAU2B,ICtMjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 2c19cc6..1cf5274 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..adcecb3 --- /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 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n){var o,a,i,d,l,c,m;for(a=s(e),i=s(r),o=t(n),l=e.length-1,d=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;mpBA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CCqJA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA1EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CA6CGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,IA1IV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA4B,EACAP,EACAQ,EACA5B,EACAC,EACA4B,EACA1B,EACAW,EACAV,EAmBJ,IAhBAuB,EAAQ/B,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBK,EAAQ1B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BK,EAAO3B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAMwB,EAAMnB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9ByB,EAAMD,EAAOd,EAAId,EAAM2B,EADnB5B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAyGEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IA7LT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CA0KCmB,CAASlC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CC1LA6B,EAAAC,EAAA,SAAAtB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index cbc649e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,250 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 3ef40ec..3d80912 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Take elements from an array.", "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,56 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1", - "@stdlib/array-base-resolve-getter": "^0.2.1", - "@stdlib/ndarray-base-ind": "^0.2.1", - "@stdlib/strided-base-reinterpret-complex": "^0.1.1", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.1", - "@stdlib/array-base-linspace": "^0.2.1", - "@stdlib/array-base-to-accessor-array": "^0.2.1", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-complex128": "^0.2.1", - "@stdlib/array-complex64": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-zeros": "^0.2.1", - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-complex64": "^0.2.1", - "@stdlib/assert-is-method": "^0.2.1", - "@stdlib/assert-is-same-complex128array": "^0.2.1", - "@stdlib/assert-is-same-complex64array": "^0.2.1", - "@stdlib/complex-imagf": "^0.2.1", - "@stdlib/complex-realf": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-array-discrete-uniform": "^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", "utilities", @@ -101,4 +28,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..a8b374b --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 1084c39..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,607 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b9c859c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,176 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 99e328b52fcf52804091653fbbfe6813c3b98a5b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 19 Jun 2024 06:39:24 +0000 Subject: [PATCH 063/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index ead268d..3ef40ec 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.1", "@stdlib/strided-base-reinterpret-complex": "^0.1.1", "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.2.1", @@ -100,4 +101,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 67d2a568a7994ee2afd15bd0836b343f384f3fdc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 19 Jun 2024 06:39:46 +0000 Subject: [PATCH 064/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 1cf5274..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index adcecb3..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n){var o,a,i,d,l,c,m;for(a=s(e),i=s(r),o=t(n),l=e.length-1,d=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;mpBA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CCqJA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA1EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CA6CGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,IA1IV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA4B,EACAP,EACAQ,EACA5B,EACAC,EACA4B,EACA1B,EACAW,EACAV,EAmBJ,IAhBAuB,EAAQ/B,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBK,EAAQ1B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BK,EAAO3B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAMwB,EAAMnB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9ByB,EAAMD,EAAOd,EAAId,EAAM2B,EADnB5B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAyGEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IA7LT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CA0KCmB,CAASlC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CC1LA6B,EAAAC,EAAA,SAAAtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a8b374b..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From adddd3c46364892925ef9c33ed403793424f2811 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 19 Jun 2024 06:40:21 +0000 Subject: [PATCH 065/123] 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 | 128 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 106 - benchmark/benchmark.js | 52 - benchmark/benchmark.length.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 250 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 79 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 607 --- test/test.js | 41 - test/test.main.js | 176 - 47 files changed, 4874 insertions(+), 5284 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 48e056d..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 f92a6c5..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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 4f84813..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff5aee8..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index f873b3a..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 03405d7..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var I=y(function(F,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,r,c){var t,s,i,o,v,a,n;for(s=j(e),i=j(r),t=G(c),v=e.length-1,o=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA2BA,SAASkB,EAAQrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK1B,EAAkBI,CAAE,EACzBQ,EAAKZ,EAAkBK,CAAQ,EAC/BsB,EAAK3B,EAAkBO,CAAI,EAE1BmB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF5B,EAAmB2B,EAAG,KAAM,GAC5B3B,EAAmB4B,EAAG,KAAM,GAE5BL,EAASrB,EAAaG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,IAERQ,EAAWW,EAAId,EAAIN,EAAMqB,EAAInB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAT,EAAO,QAAU2B,ICtMjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 60b957e..9ee9a15 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..adcecb3 --- /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 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n){var o,a,i,d,l,c,m;for(a=s(e),i=s(r),o=t(n),l=e.length-1,d=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;mpBA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CCqJA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA1EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CA6CGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,IA1IV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA4B,EACAP,EACAQ,EACA5B,EACAC,EACA4B,EACA1B,EACAW,EACAV,EAmBJ,IAhBAuB,EAAQ/B,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBK,EAAQ1B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BK,EAAO3B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAMwB,EAAMnB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9ByB,EAAMD,EAAOd,EAAId,EAAM2B,EADnB5B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAyGEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IA7LT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CA0KCmB,CAASlC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CC1LA6B,EAAAC,EAAA,SAAAtB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index cbc649e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,250 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 3ef40ec..3d80912 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Take elements from an array.", "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,56 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1", - "@stdlib/array-base-resolve-getter": "^0.2.1", - "@stdlib/ndarray-base-ind": "^0.2.1", - "@stdlib/strided-base-reinterpret-complex": "^0.1.1", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.1", - "@stdlib/array-base-linspace": "^0.2.1", - "@stdlib/array-base-to-accessor-array": "^0.2.1", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-complex128": "^0.2.1", - "@stdlib/array-complex64": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-zeros": "^0.2.1", - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-complex64": "^0.2.1", - "@stdlib/assert-is-method": "^0.2.1", - "@stdlib/assert-is-same-complex128array": "^0.2.1", - "@stdlib/assert-is-same-complex64array": "^0.2.1", - "@stdlib/complex-imagf": "^0.2.1", - "@stdlib/complex-realf": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-array-discrete-uniform": "^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", "utilities", @@ -101,4 +28,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..a8b374b --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 1084c39..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,607 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b9c859c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,176 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From eac02eac129050d145aaa80fb5373b6870c7e28f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 25 Jun 2024 19:59:58 +0000 Subject: [PATCH 066/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 42538bd..af08c67 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,8 @@ "@stdlib/strided-base-reinterpret-boolean": "^0.0.1", "@stdlib/strided-base-reinterpret-complex": "^0.1.1", "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.2.1", @@ -104,4 +105,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 6994ce48b4dff64e51596cc843f4e9a64bbd0315 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 25 Jun 2024 20:00:40 +0000 Subject: [PATCH 067/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 9ee9a15..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index adcecb3..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n){var o,a,i,d,l,c,m;for(a=s(e),i=s(r),o=t(n),l=e.length-1,d=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support complex-to-complex, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;mpBA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CCqJA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA1EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CA6CGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,IA1IV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA4B,EACAP,EACAQ,EACA5B,EACAC,EACA4B,EACA1B,EACAW,EACAV,EAmBJ,IAhBAuB,EAAQ/B,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBK,EAAQ1B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BK,EAAO3B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAMwB,EAAMnB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9ByB,EAAMD,EAAOd,EAAId,EAAM2B,EADnB5B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAyGEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IA7LT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CA0KCmB,CAASlC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CC1LA6B,EAAAC,EAAA,SAAAtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a8b374b..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From ca273024774692dd0889aaaeecdd1ce3901d6914 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 25 Jun 2024 20:01:06 +0000 Subject: [PATCH 068/123] 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 | 140 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 106 - benchmark/benchmark.js | 52 - benchmark/benchmark.length.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 83 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 47 files changed, 4874 insertions(+), 5443 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 48e056d..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 f92a6c5..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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 4f84813..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff5aee8..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index f873b3a..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 60b957e..9ee9a15 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..28f3119 --- /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 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.1-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index af08c67..3d80912 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.1", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1", - "@stdlib/array-base-resolve-getter": "^0.2.1", - "@stdlib/ndarray-base-ind": "^0.2.1", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.1", - "@stdlib/strided-base-reinterpret-complex": "^0.1.1", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.1", - "@stdlib/array-base-linspace": "^0.2.1", - "@stdlib/array-base-to-accessor-array": "^0.2.1", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-bool": "^0.0.1", - "@stdlib/array-complex128": "^0.2.1", - "@stdlib/array-complex64": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-zeros": "^0.2.1", - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-complex64": "^0.2.1", - "@stdlib/assert-is-method": "^0.2.1", - "@stdlib/assert-is-same-booleanarray": "github:stdlib-js/assert-is-same-booleanarray#main", - "@stdlib/assert-is-same-complex128array": "^0.2.1", - "@stdlib/assert-is-same-complex64array": "^0.2.1", - "@stdlib/complex-imagf": "^0.2.1", - "@stdlib/complex-realf": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-array-discrete-uniform": "^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", "utilities", @@ -105,4 +28,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..dbec644 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 70c6ce5..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isSameBooleanArray = require( '@stdlib/assert-is-same-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e165dd9..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 22c0b45722512071072b5b4e29b99b7786a3a0aa Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 17 Jul 2024 03:27:52 +0000 Subject: [PATCH 069/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 85d524c..7bf33bf 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,8 @@ "@stdlib/strided-base-reinterpret-boolean": "^0.0.1", "@stdlib/strided-base-reinterpret-complex": "^0.1.1", "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.2.1", @@ -104,4 +105,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 439ba39ead05a33047744f7a51b88f9d91a66734 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 17 Jul 2024 03:37:45 +0000 Subject: [PATCH 070/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 9ee9a15..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 28f3119..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.1-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index dbec644..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From f8ae54c4ed7da438959ed1d0ecd4a8962f0c1b00 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 17 Jul 2024 03:38:06 +0000 Subject: [PATCH 071/123] 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 | 142 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 106 - benchmark/benchmark.js | 52 - benchmark/benchmark.length.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 83 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 47 files changed, 4874 insertions(+), 5445 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 48e056d..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 f92a6c5..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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 4f84813..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff5aee8..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index f873b3a..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 60b957e..9ee9a15 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..28f3119 --- /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 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.1-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 7bf33bf..3d80912 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.1", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1", - "@stdlib/array-base-resolve-getter": "^0.2.1", - "@stdlib/ndarray-base-ind": "^0.2.1", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.1", - "@stdlib/strided-base-reinterpret-complex": "^0.1.1", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.1", - "@stdlib/array-base-linspace": "^0.2.1", - "@stdlib/array-base-to-accessor-array": "^0.2.1", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-bool": "^0.0.1", - "@stdlib/array-complex128": "^0.2.1", - "@stdlib/array-complex64": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-zeros": "^0.2.1", - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-complex64": "^0.2.1", - "@stdlib/assert-is-method": "^0.2.1", - "@stdlib/assert-is-same-booleanarray": "github:stdlib-js/assert-is-same-booleanarray#main", - "@stdlib/assert-is-same-complex128array": "^0.2.1", - "@stdlib/assert-is-same-complex64array": "^0.2.1", - "@stdlib/complex-float32-imag": "github:stdlib-js/complex-float32-imag#main", - "@stdlib/complex-float32-real": "github:stdlib-js/complex-float32-real#main", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-array-discrete-uniform": "^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", "utilities", @@ -105,4 +28,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..dbec644 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 70c6ce5..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isSameBooleanArray = require( '@stdlib/assert-is-same-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 56ad7eac3bec4e73c4ef0e187ba88ccbda8d3627 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 11:52:43 +0000 Subject: [PATCH 072/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index d4c69b0..6240f51 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,8 @@ "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", "@stdlib/strided-base-reinterpret-complex": "^0.1.2", "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.2.2", @@ -104,4 +105,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 2cf8d041d80376856866d23b97fcf70b7f6d0e74 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 11:54:02 +0000 Subject: [PATCH 073/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 9ee9a15..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 28f3119..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.1-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index dbec644..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 68f0962eeb4af76a0027c8b2257cc9a43b89c9a3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 11:54:19 +0000 Subject: [PATCH 074/123] 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 | 227 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 106 - benchmark/benchmark.js | 52 - benchmark/benchmark.length.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 83 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 47 files changed, 4874 insertions(+), 5532 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 48e056d..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 4f84813..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff5aee8..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index f873b3a..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 60b957e..9ee9a15 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..c2995f3 --- /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 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 6240f51..ba5a7da 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.0", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.1", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1", - "@stdlib/array-base-resolve-getter": "^0.2.2", - "@stdlib/ndarray-base-ind": "^0.2.2", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", - "@stdlib/strided-base-reinterpret-complex": "^0.1.2", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.2", - "@stdlib/array-base-linspace": "^0.2.2", - "@stdlib/array-base-to-accessor-array": "^0.2.1", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-bool": "^0.1.0", - "@stdlib/array-complex128": "^0.3.0", - "@stdlib/array-complex64": "^0.3.0", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-complex64": "^0.2.2", - "@stdlib/assert-is-method": "^0.2.2", - "@stdlib/assert-is-same-booleanarray": "github:stdlib-js/assert-is-same-booleanarray#main", - "@stdlib/assert-is-same-complex128array": "^0.2.1", - "@stdlib/assert-is-same-complex64array": "^0.2.1", - "@stdlib/complex-float32-imag": "^0.1.1", - "@stdlib/complex-float32-real": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-array-discrete-uniform": "^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.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -105,4 +28,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..5909870 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 70c6ce5..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isSameBooleanArray = require( '@stdlib/assert-is-same-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 62275df024f7019f1fe825aa1083a5df949507da Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 11:55:05 +0000 Subject: [PATCH 075/123] Update README.md for ESM bundle v0.3.0 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 697b9e6..36edf30 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.3.0-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.3.0-esm/index.mjs'; ``` #### take( x, indices, mode ) @@ -128,7 +128,7 @@ The function supports the following parameters: import filledBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs'; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@esm/index.mjs'; import linspace from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-linspace@esm/index.mjs'; -import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.3.0-esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From 8a26ee974920adc5635f1023694b293927cd46b9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 11:55:05 +0000 Subject: [PATCH 076/123] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 36edf30..38ed8b0 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,11 @@ limitations under the License. ## Usage +```javascript +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@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-take/tags). For example, + ```javascript import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.3.0-esm/index.mjs'; ``` @@ -48,7 +53,7 @@ import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.3.0-e You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.3.0-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; ``` #### take( x, indices, mode ) @@ -128,7 +133,7 @@ The function supports the following parameters: import filledBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs'; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@esm/index.mjs'; import linspace from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-linspace@esm/index.mjs'; -import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.3.0-esm/index.mjs'; +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From 3b8ce02460c4a942e73edcc1c0a7efda5cffb1f6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 19 May 2025 07:44:38 +0000 Subject: [PATCH 077/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 237f422..eab2124 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,8 @@ "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", "@stdlib/strided-base-reinterpret-complex": "^0.1.2", "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.2.2", @@ -104,4 +105,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 52b08093fd65a61e49c79ca2a6165f93586fb853 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 19 May 2025 07:44:56 +0000 Subject: [PATCH 078/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 9ee9a15..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index c2995f3..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 5909870..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 0e58fa8e2b02c3c58370c6e6386b4310df669b98 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 19 May 2025 07:45:35 +0000 Subject: [PATCH 079/123] 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 | 260 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 106 - benchmark/benchmark.js | 52 - benchmark/benchmark.length.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 83 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 48 files changed, 4874 insertions(+), 5673 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 2cf68c4..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 4f84813..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff5aee8..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index f873b3a..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 60b957e..9ee9a15 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..4d728c2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index eab2124..ba5a7da 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.0", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.1", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1", - "@stdlib/array-base-resolve-getter": "^0.2.2", - "@stdlib/ndarray-base-ind": "^0.2.2", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", - "@stdlib/strided-base-reinterpret-complex": "^0.1.2", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.2", - "@stdlib/array-base-linspace": "^0.2.2", - "@stdlib/array-base-to-accessor-array": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-bool": "^0.1.0", - "@stdlib/array-complex128": "^0.3.0", - "@stdlib/array-complex64": "^0.3.0", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-complex64": "^0.2.2", - "@stdlib/assert-is-equal-booleanarray": "github:stdlib-js/assert-is-equal-booleanarray#main", - "@stdlib/assert-is-method": "^0.2.2", - "@stdlib/assert-is-same-complex128array": "^0.2.2", - "@stdlib/assert-is-same-complex64array": "^0.2.2", - "@stdlib/complex-float32-imag": "^0.1.1", - "@stdlib/complex-float32-real": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-array-discrete-uniform": "^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.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -105,4 +28,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..5909870 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 3d26427..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isEqualBooleanArray = require( '@stdlib/assert-is-equal-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 503e53c686efaf70b7ad20cc17db8c4a861a0882 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 18 Aug 2025 00:52:43 +0000 Subject: [PATCH 080/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 237f422..eab2124 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,8 @@ "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", "@stdlib/strided-base-reinterpret-complex": "^0.1.2", "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.2.2", @@ -104,4 +105,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From b6fee88ee2e7aecfc067aabccf11122b18b85470 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 18 Aug 2025 00:54:47 +0000 Subject: [PATCH 081/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 9ee9a15..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 4d728c2..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 5909870..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 9e1861604ab63cd5bcc8d2f496279e7f46700eff Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 18 Aug 2025 00:55:12 +0000 Subject: [PATCH 082/123] 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 | 260 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 106 - benchmark/benchmark.js | 52 - benchmark/benchmark.length.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 83 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 49 files changed, 4874 insertions(+), 5674 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 47553d5..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-08-18T00:50:31.670Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2cf68c4..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 4f84813..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff5aee8..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index f873b3a..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 60b957e..9ee9a15 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..4d728c2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index eab2124..ba5a7da 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.0", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.1", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1", - "@stdlib/array-base-resolve-getter": "^0.2.2", - "@stdlib/ndarray-base-ind": "^0.2.2", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", - "@stdlib/strided-base-reinterpret-complex": "^0.1.2", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.2", - "@stdlib/array-base-linspace": "^0.2.2", - "@stdlib/array-base-to-accessor-array": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-bool": "^0.1.0", - "@stdlib/array-complex128": "^0.3.0", - "@stdlib/array-complex64": "^0.3.0", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-complex64": "^0.2.2", - "@stdlib/assert-is-equal-booleanarray": "github:stdlib-js/assert-is-equal-booleanarray#main", - "@stdlib/assert-is-method": "^0.2.2", - "@stdlib/assert-is-same-complex128array": "^0.2.2", - "@stdlib/assert-is-same-complex64array": "^0.2.2", - "@stdlib/complex-float32-imag": "^0.1.1", - "@stdlib/complex-float32-real": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-array-discrete-uniform": "^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.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -105,4 +28,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..5909870 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 3d26427..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isEqualBooleanArray = require( '@stdlib/assert-is-equal-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From c2a08bc45b5cab42ca64c29be39af331045000cc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 21 Sep 2025 17:46:05 +0000 Subject: [PATCH 083/123] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 237f422..eab2124 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,8 @@ "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", "@stdlib/strided-base-reinterpret-complex": "^0.1.2", "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled-by": "^0.2.2", @@ -104,4 +105,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From a124457af2260c2d9d7625b3dafc3ca3d8eb7e3e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 21 Sep 2025 17:47:04 +0000 Subject: [PATCH 084/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 9ee9a15..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 4d728c2..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 5909870..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 9380fc4eb2ad6aeda5e16ffbaef00cc8e237acc8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 21 Sep 2025 17:47:33 +0000 Subject: [PATCH 085/123] 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 | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 262 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 106 - benchmark/benchmark.js | 52 - benchmark/benchmark.length.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 83 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 48 files changed, 4874 insertions(+), 5680 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 2cf68c4..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 4f84813..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff5aee8..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,52 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index f873b3a..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index f1fcd0c..a68efa6 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..4d728c2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index eab2124..ba5a7da 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.0", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.1", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1", - "@stdlib/array-base-resolve-getter": "^0.2.2", - "@stdlib/ndarray-base-ind": "^0.2.2", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", - "@stdlib/strided-base-reinterpret-complex": "^0.1.2", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.2", - "@stdlib/array-base-linspace": "^0.2.2", - "@stdlib/array-base-to-accessor-array": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-bool": "^0.1.0", - "@stdlib/array-complex128": "^0.3.0", - "@stdlib/array-complex64": "^0.3.0", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-complex64": "^0.2.2", - "@stdlib/assert-is-equal-booleanarray": "github:stdlib-js/assert-is-equal-booleanarray#main", - "@stdlib/assert-is-method": "^0.2.2", - "@stdlib/assert-is-same-complex128array": "^0.2.2", - "@stdlib/assert-is-same-complex64array": "^0.2.2", - "@stdlib/complex-float32-imag": "^0.1.1", - "@stdlib/complex-float32-real": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-array-discrete-uniform": "^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.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -105,4 +28,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..5909870 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 3d26427..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isEqualBooleanArray = require( '@stdlib/assert-is-equal-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From bc2f23f410964adf94cf919d861d0bda562824e4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 13 Dec 2025 22:08:17 +0000 Subject: [PATCH 086/123] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index d276f2f..afe7f0f 100644 --- a/package.json +++ b/package.json @@ -69,7 +69,7 @@ "@stdlib/math-base-special-pow": "^0.3.0", "@stdlib/random-array-discrete-uniform": "^0.2.1", "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^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", From 6818cdf99d36e910fa69ba77232d0ff686ad7e2e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 13 Dec 2025 22:08:34 +0000 Subject: [PATCH 087/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 a68efa6..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-complex128' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 4d728c2..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 5909870..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 420814a8ca4352a6f26ce17ae922b28d968b1b90 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 13 Dec 2025 22:09:45 +0000 Subject: [PATCH 088/123] 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 | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 264 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 107 - benchmark/benchmark.js | 53 - benchmark/benchmark.length.js | 99 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 81 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 48 files changed, 4873 insertions(+), 5684 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 2cf68c4..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 7d5713a..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,107 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:assign:len=%d', pkg, len ), f); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 094e1ca..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,53 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index a323c53..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index f1fcd0c..a68efa6 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..4d728c2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index afe7f0f..ba5a7da 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.0", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.1", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1", - "@stdlib/array-base-resolve-getter": "^0.2.2", - "@stdlib/ndarray-base-ind": "^0.2.2", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", - "@stdlib/strided-base-reinterpret-complex": "^0.1.2", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.2", - "@stdlib/array-base-linspace": "^0.2.2", - "@stdlib/array-base-to-accessor-array": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-bool": "^0.1.0", - "@stdlib/array-complex128": "^0.3.0", - "@stdlib/array-complex64": "^0.3.0", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-complex64": "^0.2.2", - "@stdlib/assert-is-equal-booleanarray": "github:stdlib-js/assert-is-equal-booleanarray#main", - "@stdlib/assert-is-method": "^0.2.2", - "@stdlib/assert-is-same-complex128array": "^0.2.2", - "@stdlib/assert-is-same-complex64array": "^0.2.2", - "@stdlib/complex-float32-imag": "^0.1.1", - "@stdlib/complex-float32-real": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..5909870 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 3d26427..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isEqualBooleanArray = require( '@stdlib/assert-is-equal-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From f7fc2cea93ab1b07a9d5f264b5f570dc11b8f1e0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 06:20:04 +0000 Subject: [PATCH 089/123] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 227f90a..3905581 100644 --- a/package.json +++ b/package.json @@ -69,7 +69,7 @@ "@stdlib/math-base-special-pow": "^0.3.0", "@stdlib/random-array-discrete-uniform": "^0.2.1", "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^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", From 724f1b4d0860aec17e7b82114c86442d4bb98f3a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 07:11:18 +0000 Subject: [PATCH 090/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 a68efa6..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-complex128' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 4d728c2..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 5909870..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 64143b3048605ce2c4ac722634769fed32b2307f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 07:11:41 +0000 Subject: [PATCH 091/123] 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 | 264 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 107 - benchmark/benchmark.js | 53 - benchmark/benchmark.length.js | 99 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 81 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 48 files changed, 4873 insertions(+), 5784 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 2cf68c4..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 7d5713a..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,107 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:assign:len=%d', pkg, len ), f); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 094e1ca..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,53 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index a323c53..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index f1fcd0c..a68efa6 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..e294fec --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 3905581..ba5a7da 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.0", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.1", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1", - "@stdlib/array-base-resolve-getter": "^0.2.2", - "@stdlib/ndarray-base-ind": "^0.2.2", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", - "@stdlib/strided-base-reinterpret-complex": "^0.1.2", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.2", - "@stdlib/array-base-linspace": "^0.2.2", - "@stdlib/array-base-to-accessor-array": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-bool": "^0.1.1", - "@stdlib/array-complex128": "^0.3.1", - "@stdlib/array-complex64": "^0.3.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-complex64": "^0.2.2", - "@stdlib/assert-is-equal-booleanarray": "github:stdlib-js/assert-is-equal-booleanarray#main", - "@stdlib/assert-is-method": "^0.2.2", - "@stdlib/assert-is-same-complex128array": "^0.2.2", - "@stdlib/assert-is-same-complex64array": "^0.2.2", - "@stdlib/complex-float32-imag": "^0.1.1", - "@stdlib/complex-float32-real": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..5909870 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 3d26427..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isEqualBooleanArray = require( '@stdlib/assert-is-equal-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 78f0e55d9e1ece6c879ae9015dc1c5152255648a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Feb 2026 00:49:47 +0000 Subject: [PATCH 092/123] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index b2089a2..caa89bb 100644 --- a/package.json +++ b/package.json @@ -69,7 +69,7 @@ "@stdlib/math-base-special-pow": "^0.3.0", "@stdlib/random-array-discrete-uniform": "^0.2.1", "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^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", From a1e3b48ed77e1be04a717a7d938db12fe65d1301 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Feb 2026 01:00:43 +0000 Subject: [PATCH 093/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 a68efa6..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-complex128' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index e294fec..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 5909870..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e755351a30fc9254d93321491558bf561c1ef7e7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Feb 2026 01:01:07 +0000 Subject: [PATCH 094/123] 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 | 264 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 107 - benchmark/benchmark.js | 53 - benchmark/benchmark.length.js | 99 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 81 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 49 files changed, 4873 insertions(+), 5785 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 9e44566..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-02-02T00:47:54.412Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2cf68c4..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 7d5713a..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,107 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:assign:len=%d', pkg, len ), f); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 094e1ca..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,53 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index a323c53..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index f1fcd0c..a68efa6 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..73502cb --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index caa89bb..ba5a7da 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.0", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.1", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1", - "@stdlib/array-base-resolve-getter": "^0.2.2", - "@stdlib/ndarray-base-ind": "^0.2.2", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", - "@stdlib/strided-base-reinterpret-complex": "^0.1.2", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.2", - "@stdlib/array-base-linspace": "^0.2.2", - "@stdlib/array-base-to-accessor-array": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-bool": "^0.1.1", - "@stdlib/array-complex128": "^0.3.1", - "@stdlib/array-complex64": "^0.3.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-complex64": "^0.2.2", - "@stdlib/assert-is-equal-booleanarray": "^0.1.0", - "@stdlib/assert-is-method": "^0.2.2", - "@stdlib/assert-is-same-complex128array": "^0.2.2", - "@stdlib/assert-is-same-complex64array": "^0.2.2", - "@stdlib/complex-float32-imag": "^0.1.1", - "@stdlib/complex-float32-real": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..97a5c33 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 3d26427..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isEqualBooleanArray = require( '@stdlib/assert-is-equal-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 24c69fbf1dbfc73a3a947d4f3ac6e45238dbb99e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 21:35:13 +0000 Subject: [PATCH 095/123] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 85b5459..6d29f2f 100644 --- a/package.json +++ b/package.json @@ -69,7 +69,7 @@ "@stdlib/math-base-special-pow": "^0.3.1", "@stdlib/random-array-discrete-uniform": "^0.2.1", "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@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 0cb7eaa8069c3f39e9fdfda4efb9c088afc47242 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 22:43:33 +0000 Subject: [PATCH 096/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 a68efa6..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-complex128' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 73502cb..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 97a5c33..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 035b9d26ced6d1ca7781e3f2e8ed61111cc3c5e2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 22:43:53 +0000 Subject: [PATCH 097/123] 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 | 264 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 107 - benchmark/benchmark.js | 53 - benchmark/benchmark.length.js | 99 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 81 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 48 files changed, 4873 insertions(+), 5777 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 2cf68c4..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 7d5713a..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,107 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:assign:len=%d', pkg, len ), f); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 094e1ca..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,53 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index a323c53..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index f1fcd0c..a68efa6 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..489c3bb --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 6d29f2f..ea7cd50 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.1", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.2", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.2", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.2", - "@stdlib/array-base-resolve-getter": "^0.2.3", - "@stdlib/ndarray-base-ind": "^0.2.3", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.3", - "@stdlib/strided-base-reinterpret-complex": "^0.1.3", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-base-linspace": "^0.2.3", - "@stdlib/array-base-to-accessor-array": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-bool": "^0.1.2", - "@stdlib/array-complex128": "^0.3.2", - "@stdlib/array-complex64": "^0.3.2", - "@stdlib/array-float64": "^0.2.3", - "@stdlib/array-zeros": "^0.2.3", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-array": "^0.2.3", - "@stdlib/assert-is-complex64": "^0.2.3", - "@stdlib/assert-is-equal-booleanarray": "^0.1.0", - "@stdlib/assert-is-method": "^0.2.3", - "@stdlib/assert-is-same-complex128array": "^0.2.2", - "@stdlib/assert-is-same-complex64array": "^0.2.2", - "@stdlib/complex-float32-imag": "^0.1.2", - "@stdlib/complex-float32-real": "^0.1.2", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@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", "utilities", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c7f68bf --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 3d26427..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isEqualBooleanArray = require( '@stdlib/assert-is-equal-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 7c5e3e698688e30393c59924af7c954310ca1e93 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 23:00:19 +0000 Subject: [PATCH 098/123] Update README.md for ESM bundle v0.3.1 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 676187c..2388593 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.3.1-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.3.1-esm/index.mjs'; ``` #### take( x, indices, mode ) @@ -128,7 +128,7 @@ The function supports the following parameters: import filledBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs'; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@esm/index.mjs'; import linspace from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-linspace@esm/index.mjs'; -import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.3.1-esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From 11225c0644329c19ccf368e974a4e3fe29e517bc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 23:00:20 +0000 Subject: [PATCH 099/123] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2388593..362c71e 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,11 @@ limitations under the License. ## Usage +```javascript +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@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-take/tags). For example, + ```javascript import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.3.1-esm/index.mjs'; ``` @@ -48,7 +53,7 @@ import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.3.1-e You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.3.1-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; ``` #### take( x, indices, mode ) @@ -128,7 +133,7 @@ The function supports the following parameters: import filledBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs'; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@esm/index.mjs'; import linspace from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-linspace@esm/index.mjs'; -import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@v0.3.1-esm/index.mjs'; +import take from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take@esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From 2ecbd057cf45ab334427564fc324d96fccc4c3e2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 16 Feb 2026 01:31:30 +0000 Subject: [PATCH 100/123] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 5b45352..13ddd82 100644 --- a/package.json +++ b/package.json @@ -69,7 +69,7 @@ "@stdlib/math-base-special-pow": "^0.3.1", "@stdlib/random-array-discrete-uniform": "^0.2.2", "@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 1db0adb8800cf733e1b396cec6696b663e91fd55 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 16 Feb 2026 02:03:09 +0000 Subject: [PATCH 101/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 a68efa6..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-complex128' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 489c3bb..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index c7f68bf..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 0fc4ec712e0a13d5515195fc5cd1548844df7a2a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 16 Feb 2026 02:03:32 +0000 Subject: [PATCH 102/123] 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 | 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 | 264 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 107 - benchmark/benchmark.js | 53 - benchmark/benchmark.length.js | 99 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 81 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 49 files changed, 4873 insertions(+), 5778 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 3a763c5..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-02-16T01:19:43.732Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2cf68c4..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 7d5713a..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,107 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:assign:len=%d', pkg, len ), f); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 094e1ca..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,53 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index a323c53..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index f1fcd0c..a68efa6 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..489c3bb --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 13ddd82..ea7cd50 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.1", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.2", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.2", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.2", - "@stdlib/array-base-resolve-getter": "^0.2.3", - "@stdlib/ndarray-base-ind": "^0.2.3", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.3", - "@stdlib/strided-base-reinterpret-complex": "^0.1.3", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-base-linspace": "^0.2.3", - "@stdlib/array-base-to-accessor-array": "^0.2.3", - "@stdlib/array-base-zero-to": "^0.2.2", - "@stdlib/array-bool": "^0.1.2", - "@stdlib/array-complex128": "^0.3.2", - "@stdlib/array-complex64": "^0.3.2", - "@stdlib/array-float64": "^0.2.3", - "@stdlib/array-zeros": "^0.2.3", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-array": "^0.2.3", - "@stdlib/assert-is-complex64": "^0.2.3", - "@stdlib/assert-is-equal-booleanarray": "^0.1.1", - "@stdlib/assert-is-method": "^0.2.3", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/assert-is-same-complex64array": "^0.2.3", - "@stdlib/complex-float32-imag": "^0.1.2", - "@stdlib/complex-float32-real": "^0.1.2", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@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", "utilities", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c7f68bf --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 3d26427..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isEqualBooleanArray = require( '@stdlib/assert-is-equal-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 2f862491acfef13f97a3429719096e3a59e749e8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 8 Apr 2026 03:54:31 +0000 Subject: [PATCH 103/123] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 5b45352..13ddd82 100644 --- a/package.json +++ b/package.json @@ -69,7 +69,7 @@ "@stdlib/math-base-special-pow": "^0.3.1", "@stdlib/random-array-discrete-uniform": "^0.2.2", "@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 7c91104e0a151abbe3d1213013cbc509e0ac6542 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 8 Apr 2026 04:10:38 +0000 Subject: [PATCH 104/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 a68efa6..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-complex128' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 489c3bb..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index c7f68bf..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 41f3ab48b87ee3b3778828eeedb53bd1aa936a4c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 8 Apr 2026 04:11:21 +0000 Subject: [PATCH 105/123] 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 | 264 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 107 - benchmark/benchmark.js | 53 - benchmark/benchmark.length.js | 99 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 81 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 49 files changed, 4873 insertions(+), 5789 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 7776378..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-04-08T03:44:16.119Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2cf68c4..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index 7d5713a..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,107 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:assign:len=%d', pkg, len ), f); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 094e1ca..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,53 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index a323c53..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index f1fcd0c..a68efa6 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..489c3bb --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 13ddd82..ea7cd50 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.1", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.2", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.2", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.2", - "@stdlib/array-base-resolve-getter": "^0.2.3", - "@stdlib/ndarray-base-ind": "^0.2.3", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.3", - "@stdlib/strided-base-reinterpret-complex": "^0.1.3", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-base-linspace": "^0.2.3", - "@stdlib/array-base-to-accessor-array": "^0.2.3", - "@stdlib/array-base-zero-to": "^0.2.2", - "@stdlib/array-bool": "^0.1.2", - "@stdlib/array-complex128": "^0.3.2", - "@stdlib/array-complex64": "^0.3.2", - "@stdlib/array-float64": "^0.2.3", - "@stdlib/array-zeros": "^0.2.3", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-array": "^0.2.3", - "@stdlib/assert-is-complex64": "^0.2.3", - "@stdlib/assert-is-equal-booleanarray": "^0.1.1", - "@stdlib/assert-is-method": "^0.2.3", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/assert-is-same-complex64array": "^0.2.3", - "@stdlib/complex-float32-imag": "^0.1.2", - "@stdlib/complex-float32-real": "^0.1.2", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@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", "utilities", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c7f68bf --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 3d26427..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isEqualBooleanArray = require( '@stdlib/assert-is-equal-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 3ec9a8ee9d864a8802b82cc885e8e23e7bea8e91 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 21 Apr 2026 00:39:26 +0000 Subject: [PATCH 106/123] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 5b45352..13ddd82 100644 --- a/package.json +++ b/package.json @@ -69,7 +69,7 @@ "@stdlib/math-base-special-pow": "^0.3.1", "@stdlib/random-array-discrete-uniform": "^0.2.2", "@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 a5934dca8607479aa274d53dcfe7d7d5736a3fe3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 21 Apr 2026 00:58:36 +0000 Subject: [PATCH 107/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 a68efa6..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-complex128' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 489c3bb..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index c7f68bf..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 88a7e0e47da97d9a0add4f6a18f2dc2ceac3439c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 21 Apr 2026 00:58:53 +0000 Subject: [PATCH 108/123] 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 | 298 -- CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 107 - benchmark/benchmark.js | 53 - benchmark/benchmark.length.js | 99 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 81 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 48 files changed, 4873 insertions(+), 5822 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 2cf68c4..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index c6c6fc8..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,107 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:assign:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 094e1ca..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,53 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index a323c53..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index f1fcd0c..a68efa6 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..489c3bb --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 13ddd82..ea7cd50 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.1", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.2", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.2", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.2", - "@stdlib/array-base-resolve-getter": "^0.2.3", - "@stdlib/ndarray-base-ind": "^0.2.3", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.3", - "@stdlib/strided-base-reinterpret-complex": "^0.1.3", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-base-linspace": "^0.2.3", - "@stdlib/array-base-to-accessor-array": "^0.2.3", - "@stdlib/array-base-zero-to": "^0.2.2", - "@stdlib/array-bool": "^0.1.2", - "@stdlib/array-complex128": "^0.3.2", - "@stdlib/array-complex64": "^0.3.2", - "@stdlib/array-float64": "^0.2.3", - "@stdlib/array-zeros": "^0.2.3", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-array": "^0.2.3", - "@stdlib/assert-is-complex64": "^0.2.3", - "@stdlib/assert-is-equal-booleanarray": "^0.1.1", - "@stdlib/assert-is-method": "^0.2.3", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/assert-is-same-complex64array": "^0.2.3", - "@stdlib/complex-float32-imag": "^0.1.2", - "@stdlib/complex-float32-real": "^0.1.2", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@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", "utilities", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c7f68bf --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 3d26427..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isEqualBooleanArray = require( '@stdlib/assert-is-equal-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From fcf2978d8e9ee5fb74de65d8a5c356440e25fff9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 10 May 2026 21:22:11 +0000 Subject: [PATCH 109/123] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 5b45352..13ddd82 100644 --- a/package.json +++ b/package.json @@ -69,7 +69,7 @@ "@stdlib/math-base-special-pow": "^0.3.1", "@stdlib/random-array-discrete-uniform": "^0.2.2", "@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 e3e85a17bce6090951d2750288085feac1e89e39 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 10 May 2026 21:34:24 +0000 Subject: [PATCH 110/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 a68efa6..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-complex128' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-float64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 489c3bb..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index c7f68bf..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From fdb42d646691e94734b3c5bf53684c2593b9e097 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 10 May 2026 21:34:49 +0000 Subject: [PATCH 111/123] 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 | 31 - CHANGELOG.md | 299 -- CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 107 - benchmark/benchmark.js | 53 - benchmark/benchmark.length.js | 99 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 81 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 48 files changed, 4873 insertions(+), 5828 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 2cf68c4..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index c6c6fc8..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,107 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:assign:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 094e1ca..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,53 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index a323c53..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 078fa3e..01acb54 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..489c3bb --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 13ddd82..ea7cd50 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.1", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.2", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.2", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.2", - "@stdlib/array-base-resolve-getter": "^0.2.3", - "@stdlib/ndarray-base-ind": "^0.2.3", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.3", - "@stdlib/strided-base-reinterpret-complex": "^0.1.3", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-base-linspace": "^0.2.3", - "@stdlib/array-base-to-accessor-array": "^0.2.3", - "@stdlib/array-base-zero-to": "^0.2.2", - "@stdlib/array-bool": "^0.1.2", - "@stdlib/array-complex128": "^0.3.2", - "@stdlib/array-complex64": "^0.3.2", - "@stdlib/array-float64": "^0.2.3", - "@stdlib/array-zeros": "^0.2.3", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-array": "^0.2.3", - "@stdlib/assert-is-complex64": "^0.2.3", - "@stdlib/assert-is-equal-booleanarray": "^0.1.1", - "@stdlib/assert-is-method": "^0.2.3", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/assert-is-same-complex64array": "^0.2.3", - "@stdlib/complex-float32-imag": "^0.1.2", - "@stdlib/complex-float32-real": "^0.1.2", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@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", "utilities", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c7f68bf --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 3d26427..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isEqualBooleanArray = require( '@stdlib/assert-is-equal-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 6c36e2407303d7ce91b65903e51510d2d5de5255 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 16 May 2026 03:41:44 +0000 Subject: [PATCH 112/123] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 5b45352..13ddd82 100644 --- a/package.json +++ b/package.json @@ -69,7 +69,7 @@ "@stdlib/math-base-special-pow": "^0.3.1", "@stdlib/random-array-discrete-uniform": "^0.2.2", "@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 b09d02706a573c7cca835fa34e3446ca89b9c3f6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 16 May 2026 03:52:22 +0000 Subject: [PATCH 113/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 01acb54..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-complex128' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-complex64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 489c3bb..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index c7f68bf..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 0a8e7ca66744c68774c387fe32c8a84832db0c2a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 16 May 2026 03:52:47 +0000 Subject: [PATCH 114/123] 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 | 31 - CHANGELOG.md | 299 -- CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 107 - benchmark/benchmark.js | 53 - benchmark/benchmark.length.js | 99 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 81 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 49 files changed, 4873 insertions(+), 5829 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 ba07672..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-05-16T03:39:46.763Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2cf68c4..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index c6c6fc8..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,107 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:assign:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 094e1ca..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,53 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index a323c53..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 078fa3e..01acb54 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..489c3bb --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 13ddd82..ea7cd50 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.1", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.2", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.2", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.2", - "@stdlib/array-base-resolve-getter": "^0.2.3", - "@stdlib/ndarray-base-ind": "^0.2.3", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.3", - "@stdlib/strided-base-reinterpret-complex": "^0.1.3", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-base-linspace": "^0.2.3", - "@stdlib/array-base-to-accessor-array": "^0.2.3", - "@stdlib/array-base-zero-to": "^0.2.2", - "@stdlib/array-bool": "^0.1.2", - "@stdlib/array-complex128": "^0.3.2", - "@stdlib/array-complex64": "^0.3.2", - "@stdlib/array-float64": "^0.2.3", - "@stdlib/array-zeros": "^0.2.3", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-array": "^0.2.3", - "@stdlib/assert-is-complex64": "^0.2.3", - "@stdlib/assert-is-equal-booleanarray": "^0.1.1", - "@stdlib/assert-is-method": "^0.2.3", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/assert-is-same-complex64array": "^0.2.3", - "@stdlib/complex-float32-imag": "^0.1.2", - "@stdlib/complex-float32-real": "^0.1.2", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@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", "utilities", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c7f68bf --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 3d26427..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isEqualBooleanArray = require( '@stdlib/assert-is-equal-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From aa7c94184a5305cc0e135dec853d50c49d891cdb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 19 May 2026 03:46:46 +0000 Subject: [PATCH 115/123] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 5b45352..13ddd82 100644 --- a/package.json +++ b/package.json @@ -69,7 +69,7 @@ "@stdlib/math-base-special-pow": "^0.3.1", "@stdlib/random-array-discrete-uniform": "^0.2.2", "@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 8ddae7d9544c02c7adb834a86af6b3d5a56617f6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 19 May 2026 03:59:44 +0000 Subject: [PATCH 116/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 01acb54..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-complex128' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-complex64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 489c3bb..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index c7f68bf..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e9021950bd96e5c472cb33deda55f60dbb4944cd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 19 May 2026 04:00:04 +0000 Subject: [PATCH 117/123] 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 | 31 - CHANGELOG.md | 299 -- CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 107 - benchmark/benchmark.js | 53 - benchmark/benchmark.length.js | 99 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 81 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 49 files changed, 4873 insertions(+), 5829 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 39116fb..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-05-19T03:42:43.204Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2cf68c4..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index c6c6fc8..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,107 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:assign:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 094e1ca..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,53 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index a323c53..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3c35641..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(e,t){return function(){return t||e((t={exports:{}}).exports,t),t.exports}};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(e,t,c){var r,i,s,n,v,a,o;for(i=j(e),s=j(t),r=G(c),v=e.length-1,n=[],a=0;a[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 078fa3e..01acb54 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..489c3bb --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 13ddd82..ea7cd50 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.1", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.2", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.2", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.2", - "@stdlib/array-base-resolve-getter": "^0.2.3", - "@stdlib/ndarray-base-ind": "^0.2.3", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.3", - "@stdlib/strided-base-reinterpret-complex": "^0.1.3", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-base-linspace": "^0.2.3", - "@stdlib/array-base-to-accessor-array": "^0.2.3", - "@stdlib/array-base-zero-to": "^0.2.2", - "@stdlib/array-bool": "^0.1.2", - "@stdlib/array-complex128": "^0.3.2", - "@stdlib/array-complex64": "^0.3.2", - "@stdlib/array-float64": "^0.2.3", - "@stdlib/array-zeros": "^0.2.3", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-array": "^0.2.3", - "@stdlib/assert-is-complex64": "^0.2.3", - "@stdlib/assert-is-equal-booleanarray": "^0.1.1", - "@stdlib/assert-is-method": "^0.2.3", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/assert-is-same-complex64array": "^0.2.3", - "@stdlib/complex-float32-imag": "^0.1.2", - "@stdlib/complex-float32-real": "^0.1.2", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@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", "utilities", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c7f68bf --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 3d26427..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isEqualBooleanArray = require( '@stdlib/assert-is-equal-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From afa74031d3b08a7e3d9e6c615d102cec1b568469 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jun 2026 03:59:08 +0000 Subject: [PATCH 118/123] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 6f1d7c1..94a4983 100644 --- a/package.json +++ b/package.json @@ -69,7 +69,7 @@ "@stdlib/math-base-special-pow": "^0.3.1", "@stdlib/random-array-discrete-uniform": "^0.2.2", "@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 3cd931dcbced061864abeef1e61de9171cad0df6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jun 2026 04:10:16 +0000 Subject: [PATCH 119/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 01acb54..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-complex128' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-complex64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 489c3bb..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index c7f68bf..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 092bc1a170e4e40d044f46580e0e9e789924e666 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jun 2026 04:10:38 +0000 Subject: [PATCH 120/123] 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 | 299 -- CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 107 - benchmark/benchmark.js | 53 - benchmark/benchmark.length.js | 99 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 81 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 49 files changed, 4873 insertions(+), 5842 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 ea4143e..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-06-29T03:52:17.152Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2cf68c4..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index c6c6fc8..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,107 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:assign:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 094e1ca..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,53 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index a323c53..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 32599e9..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(t,r){return function(){try{return r||t((r={exports:{}}).exports,r),r.exports}catch(i){throw (r=0, i)}};};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(t,r,i){var a,s,c,n,v,e,o;for(s=j(t),c=j(r),a=G(i),v=t.length-1,n=[],e=0;e[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 078fa3e..01acb54 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..489c3bb --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 94a4983..ea7cd50 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.1", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.2", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.2", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.2", - "@stdlib/array-base-resolve-getter": "^0.2.3", - "@stdlib/ndarray-base-ind": "^0.2.3", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.3", - "@stdlib/strided-base-reinterpret-complex": "^0.1.3", - "@stdlib/types": "^0.5.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-base-linspace": "^0.2.3", - "@stdlib/array-base-to-accessor-array": "^0.2.3", - "@stdlib/array-base-zero-to": "^0.2.2", - "@stdlib/array-bool": "^0.1.2", - "@stdlib/array-complex128": "^0.3.2", - "@stdlib/array-complex64": "^0.3.2", - "@stdlib/array-float64": "^0.2.3", - "@stdlib/array-zeros": "^0.2.3", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-array": "^0.2.3", - "@stdlib/assert-is-complex64": "^0.2.3", - "@stdlib/assert-is-equal-booleanarray": "^0.1.1", - "@stdlib/assert-is-method": "^0.2.3", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/assert-is-same-complex64array": "^0.2.3", - "@stdlib/complex-float32-imag": "^0.1.2", - "@stdlib/complex-float32-real": "^0.1.2", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@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", "utilities", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c7f68bf --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 3d26427..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isEqualBooleanArray = require( '@stdlib/assert-is-equal-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 5eb902a613b1a553d03a739b381ba785d3cd2d4a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 18 Aug 2026 03:09:04 +0000 Subject: [PATCH 121/123] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 6f1d7c1..94a4983 100644 --- a/package.json +++ b/package.json @@ -69,7 +69,7 @@ "@stdlib/math-base-special-pow": "^0.3.1", "@stdlib/random-array-discrete-uniform": "^0.2.2", "@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 75049cf9d6ff54b4a9a9541610b77e7c49b96aa5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 18 Aug 2026 03:24:39 +0000 Subject: [PATCH 122/123] Remove files --- index.d.ts | 429 ----- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5276 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 01acb54..0000000 --- a/index.d.ts +++ /dev/null @@ -1,429 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Interface describing `take`. -*/ -interface Take { - /** - * Takes elements from an array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * var y = take( x, [ 1, 3 ], 'throw' ); - * // returns [ 2, 4 ] - */ - ( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float64Array, stride: number, offset: number ): Float64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Float32Array = require( '@stdlib/array-float32' ); - * - * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - * var out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2.0, 0.0, 4.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Float32Array, stride: number, offset: number ): Float32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex128Array = require( '@stdlib/array-complex128' ); - * - * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex128Array, stride: number, offset: number ): Complex128Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Complex64Array = require( '@stdlib/array-complex64' ); - * - * var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - * var out = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Complex64Array, stride: number, offset: number ): Complex64Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int32Array = require( '@stdlib/array-int32' ); - * - * var x = new Int32Array( [ 1, 2, 3, 4 ] ); - * var out = new Int32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int32Array, stride: number, offset: number ): Int32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int16Array = require( '@stdlib/array-int16' ); - * - * var x = new Int16Array( [ 1, 2, 3, 4 ] ); - * var out = new Int16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int16Array, stride: number, offset: number ): Int16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Int8Array = require( '@stdlib/array-int8' ); - * - * var x = new Int8Array( [ 1, 2, 3, 4 ] ); - * var out = new Int8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Int8Array, stride: number, offset: number ): Int8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint32Array = require( '@stdlib/array-uint32' ); - * - * var x = new Uint32Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint32Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint32Array, stride: number, offset: number ): Uint32Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint16Array = require( '@stdlib/array-uint16' ); - * - * var x = new Uint16Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint16Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint16Array, stride: number, offset: number ): Uint16Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8Array = require( '@stdlib/array-uint8' ); - * - * var x = new Uint8Array( [ 1, 2, 3, 4 ] ); - * var out = new Uint8Array( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8Array, stride: number, offset: number ): Uint8Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); - * - * var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - * var out = new Uint8ClampedArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Uint8ClampedArray, stride: number, offset: number ): Uint8ClampedArray; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Array, stride: number, offset: number ): Array; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); - * - * var x = [ 1, 2, 3, 4 ]; - * var out = toAccessorArray( [ 0, 0, 0, 0 ] ); - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * - * var bool = ( arr === out ); - * // returns true - * - * var v = arr.get( 0 ); - * // returns 2 - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array and assigns the value to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param out - output array - * @param stride - output array stride - * @param offset - output array offset - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * var out = [ 0, 0, 0, 0 ]; - * - * var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); - * // returns [ 2, 0, 4, 0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var y = take( x, [ 1, 3 ], 'throw' ); -* // returns [ 2, 4 ] -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = take.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ); -* // returns [ 2, 0, 4, 0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare var take: Take; - - -// EXPORTS // - -export = take; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 489c3bb..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 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index c7f68bf..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From b30a654e7aca1ad9b83932a85b702ce91599cc0d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 18 Aug 2026 03:25:08 +0000 Subject: [PATCH 123/123] 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 | 205 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 299 -- CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 107 - benchmark/benchmark.js | 53 - benchmark/benchmark.length.js | 99 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 8 - dist/index.js.map | 7 - docs/repl.txt | 82 - docs/types/test.ts | 180 - examples/index.js | 37 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 311 -- lib/index.js | 64 - lib/main.js | 75 - package.json | 81 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 676 --- test/test.js | 41 - test/test.main.js | 189 - 49 files changed, 4873 insertions(+), 5843 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.assign.length.js delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.length.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js 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.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.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 718ef34..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-08-18T03:05:51.703Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2cf68c4..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/take) 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 2e83b65..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/take) 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 ede7d57..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: '11 23 * * 4' - - # 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 + + ```
@@ -172,7 +169,7 @@ console.log( y ); ## 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]. @@ -235,7 +232,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take/main/LICENSE -[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind +[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray-base-ind/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.assign.length.js b/benchmark/benchmark.assign.length.js deleted file mode 100644 index c6c6fc8..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,107 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var zeros = require( '@stdlib/array-zeros' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var out; - var idx; - - idx = discreteUniform( len, 0, 3, { - 'dtype': 'generic' - }); - out = zeros( len, 'generic' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take.assign( x, idx, 'throw', out, 1, 0 ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:assign:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 094e1ca..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,53 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, x, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index a323c53..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isArray = require( '@stdlib/assert-is-array' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var take = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var idx = discreteUniform( len, 0, 3 ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var x; - var v; - var i; - - x = [ 1, 2, 3, 4 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = take( x, idx, 'throw' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index fe2310f..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/take" -%% click B href "https://github.com/stdlib-js/array-base-take/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take -[production-url]: https://github.com/stdlib-js/array-base-take/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take/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 25a4702..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import take from '../docs/types/index'; -export = take; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 32599e9..0000000 --- a/dist/index.js +++ /dev/null @@ -1,8 +0,0 @@ -"use strict";var y=function(t,r){return function(){try{return r||t((r={exports:{}}).exports,r),r.exports}catch(i){throw (r=0, i)}};};var I=y(function(K,m){ -var j=require('@stdlib/array-base-resolve-getter/dist'),G=require('@stdlib/ndarray-base-ind/dist').factory;function O(t,r,i){var a,s,c,n,v,e,o;for(s=j(t),c=j(r),a=G(i),v=t.length-1,n=[],e=0;e[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var take = require( '@stdlib/array-base-take' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAM,QAAS,0BAA2B,EAAE,QAoBhD,SAASC,EAAMC,EAAGC,EAASC,EAAO,CACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOP,EAAeG,CAAE,EACxBK,EAAOR,EAAeI,CAAQ,EAG9BE,EAAWL,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBM,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIP,EAAQ,OAAQO,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,CAAE,EAAGD,CAAI,EACtCD,EAAI,KAAMF,EAAMJ,EAAGS,CAAE,CAAE,EAExB,OAAOH,CACR,CAKAV,EAAO,QAAUG,IC1EjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAoB,QAAS,gDAAiD,EAC9EC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAM,QAAS,0BAA2B,EAAE,QA0BhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIJ,EAAUL,EAASQ,CAAE,EAAGF,CAAI,EAChCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASQ,EAAWX,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CAC3D,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQZ,EAAE,KACVa,EAAQZ,EAAQ,KAChBa,EAAQX,EAAI,KAEZY,EAAOf,EAAE,UAAW,CAAE,EACtBgB,EAAOf,EAAQ,UAAW,CAAE,EAC5BgB,EAAOd,EAAI,UAAW,CAAE,EAGxBG,EAAWR,EAAKI,CAAK,EAGrBK,EAAMK,EAAM,OAAS,EAGrBJ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCU,EAAMH,EAAON,EAAIO,EAAMH,EAAOF,CAAE,CAAE,EAClCF,GAAMJ,EAEP,OAAOU,CACR,CA0BA,SAASI,EAASlB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAQP,EAAE,OAAO,EAAM,EAGvBmB,EAAKf,EAAS,EACdI,EAAKH,EAAS,EACRI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EACRP,EAAKK,CAAG,EAAIR,EAAGoB,CAAE,EACjBjB,EAAKK,EAAG,CAAE,EAAIR,EAAGoB,EAAE,CAAE,EACrBZ,GAAMW,EAEP,OAAOhB,CACR,CA0BA,SAASkB,EAASrB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACzD,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAC,EACAC,EAaJ,IAXAG,EAAQZ,EAAQ,KAChBe,EAAOf,EAAQ,UAAW,CAAE,EAG5BK,EAAWR,EAAKI,CAAK,EAGrBK,EAAMP,EAAE,OAAS,EAGjBQ,EAAKH,EACCI,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCJ,EAAKK,CAAG,EAAIR,EAAGU,CAAE,EACjBF,GAAMJ,EAEP,OAAOD,CACR,CA2BA,SAASmB,EAAQtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAS,CACxD,IAAIkB,EACAf,EACAgB,EAKJ,OAHAD,EAAK5B,EAAkBK,CAAE,EACzBQ,EAAKb,EAAkBM,CAAQ,EAC/BuB,EAAK7B,EAAkBQ,CAAI,EAE1BoB,EAAG,kBACHf,EAAG,kBACHgB,EAAG,iBAIF/B,EAAmB8B,EAAG,KAAM,GAC5B9B,EAAmB+B,EAAG,KAAM,GAE5BN,EAAStB,EAAaI,EAAG,CAAE,EAAGQ,EAAIN,EAAMN,EAAaO,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACvEF,GAGPT,EAAmB6B,EAAG,KAAM,GAC5B7B,EAAmB8B,EAAG,KAAM,GAE5BH,EAASxB,EAAoBG,EAAG,CAAE,EAAGQ,EAAIN,EAAML,EAAoBM,EAAK,CAAE,EAAGC,EAAQC,CAAO,EACrFF,IAERQ,EAAWY,EAAIf,EAAIN,EAAMsB,EAAIpB,EAAQC,CAAO,EACrCF,IAERJ,EAASC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,CAAO,EACxCF,EACR,CAKAX,EAAO,QAAU8B,ICnQjB,IAAIG,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "resolveGetter", "ind", "take", "x", "indices", "mode", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "isBooleanDataType", "arraylike2object", "reinterpret", "reinterpretBoolean", "ind", "indexed", "x", "indices", "mode", "out", "stride", "offset", "getIndex", "max", "io", "i", "j", "accessors", "xdata", "idata", "odata", "xget", "iget", "oset", "complex", "so", "k", "boolean", "assign", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 429279b..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,82 +0,0 @@ - -{{alias}}( x, indices, mode ) - Takes elements from an array. - - If `indices` is an empty array, the function returns an empty array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw' ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset ) - Takes elements from an array and assigns the values to elements in a - provided output array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - indices: ArrayLikeObject - List of element indices. - - mode: string - Specifies how to handle an index outside the interval [0, max], where - `max` is the maximum possible array index. If equal to 'throw', the - function throws an error. If equal to 'normalize', the function throws - an error if provided an out-of-bounds normalized index. If equal to - 'wrap', the function wraps around an index using modulo arithmetic. If - equal to 'clamp', the function sets an index to either 0 (minimum index) - or the maximum index. - - out: ArrayLikeObject - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array offset. - - Returns - ------- - out: ArrayLikeObject - Output array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = [ 0, 0, 0, 0 ]; - > var arr = {{alias}}.assign( x, [ 1, 3 ], 'throw', out, 2, 0 ) - [ 2, 0, 4, 0 ] - > var bool = ( arr === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8aa4af3..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import take = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw' ); // $ExpectType number[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize' ); // $ExpectType any[] - take( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp' ); // $ExpectType number[] - take( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - take( 1, [ 1, 3 ], 'throw' ); // $ExpectError - take( true, [ 1, 3 ], 'throw' ); // $ExpectError - take( false, [ 1, 3 ], 'throw' ); // $ExpectError - take( null, [ 1, 3 ], 'throw' ); // $ExpectError - take( void 0, [ 1, 3 ], 'throw' ); // $ExpectError - take( {}, [ 1, 3 ], 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - take( [], 1, 'throw' ); // $ExpectError - take( [], true, 'throw' ); // $ExpectError - take( [], false, 'throw' ); // $ExpectError - take( [], null, 'throw' ); // $ExpectError - take( [], void 0, 'throw' ); // $ExpectError - take( [], {}, 'throw' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - take( [], [ 1, 3 ], '1' ); // $ExpectError - take( [], [ 1, 3 ], 1 ); // $ExpectError - take( [], [ 1, 3 ], true ); // $ExpectError - take( [], [ 1, 3 ], false ); // $ExpectError - take( [], [ 1, 3 ], null ); // $ExpectError - take( [], [ 1, 3 ], void 0 ); // $ExpectError - take( [], [ 1, 3 ], {} ); // $ExpectError - take( [], [ 1, 3 ], [] ); // $ExpectError - take( [], [ 1, 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - take(); // $ExpectError - take( [] ); // $ExpectError - take( [], [] ); // $ExpectError - take( [], [], 'throw', {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3, 4 ]; - const y = new Complex128Array( 4 ); - - take.assign( x, [ 1, 3 ], 'throw', [ 0, 0, 0, 0 ], 1, 0 ); // $ExpectType number[] - take.assign( x, [ 1, 3 ], 'throw', new Float64Array( 4 ), 1, 0 ); // $ExpectType Float64Array - take.assign( x, [ 1, 3 ], 'throw', new Float32Array( 4 ), 1, 0 ); // $ExpectType Float32Array - take.assign( x, [ 1, 3 ], 'throw', new Int32Array( 4 ), 1, 0 ); // $ExpectType Int32Array - take.assign( x, [ 1, 3 ], 'throw', new Int16Array( 4 ), 1, 0 ); // $ExpectType Int16Array - take.assign( x, [ 1, 3 ], 'throw', new Int8Array( 4 ), 1, 0 ); // $ExpectType Int8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint32Array( 4 ), 1, 0 ); // $ExpectType Uint32Array - take.assign( x, [ 1, 3 ], 'throw', new Uint16Array( 4 ), 1, 0 ); // $ExpectType Uint16Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8Array( 4 ), 1, 0 ); // $ExpectType Uint8Array - take.assign( x, [ 1, 3 ], 'throw', new Uint8ClampedArray( 4 ), 1, 0 ); // $ExpectType Uint8ClampedArray - take.assign( y, [ 1, 3 ], 'throw', new Complex128Array( 4 ), 1, 0 ); // $ExpectType Complex128Array - take.assign( y, [ 1, 3 ], 'throw', new Complex64Array( 4 ), 1, 0 ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( 1, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( true, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( false, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( null, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( void 0, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError - take.assign( {}, [ 1, 3 ], 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], 1, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], true, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], false, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], null, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], void 0, 'throw', out, 1, 0 ); // $ExpectError - take.assign( [], {}, 'throw', out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a valid index mode... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], '1', out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 1, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], true, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], false, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], null, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], void 0, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], {}, out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], [], out, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], ( x: number ): number => x, out, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - take.assign( [], [ 1, 3 ], 'throw', 1, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', true, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', false, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', null, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', void 0, 1, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', {}, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, '1', 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, true, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, false, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, null, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, void 0, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, {}, 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, [], 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const out = [ 0, 0, 0, 0 ]; - - take.assign( [], [ 1, 3 ], 'throw', out, 1, '1' ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, true ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, false ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, null ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, void 0 ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, {} ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, [] ); // $ExpectError - take.assign( [], [ 1, 3 ], 'throw', out, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - take.assign(); // $ExpectError - take.assign( [] ); // $ExpectError - take.assign( [], [] ); // $ExpectError - take.assign( [], [], 'throw' ); // $ExpectError - take.assign( [], [], 'throw', [] ); // $ExpectError - take.assign( [], [], 'throw', [], 1 ); // $ExpectError - take.assign( [], [], 'throw', [], 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f52851d..0000000 --- a/examples/index.js +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var take = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate an array of random indices: -var N = discreteUniform( 5, 15 ); -var indices = filledBy( N, discreteUniform.factory( 0, x.length-1 ) ); -console.log( indices ); - -// Take a random sample of elements from `x`: -var y = take( x, indices, 'throw' ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 078fa3e..01acb54 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..489c3bb --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind@v0.2.3-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-boolean-data-type@v0.0.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.3-esm/index.mjs";function i(e,r,n){var o,a,d,i,l,c,m;for(a=t(e),d=t(r),o=s(n),l=e.length-1,i=[],c=0;c[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complex( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar so;\n\tvar i;\n\tvar j;\n\tvar k;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = ( x.length/2 ) - 1; // resolve the length of the original complex array\n\n\t// Extract each desired element from the provided array...\n\tso = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components\n\tio = offset * 2;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tk = j * 2;\n\t\tout[ io ] = x[ k ];\n\t\tout[ io+1 ] = x[ k+1 ];\n\t\tio += so;\n\t}\n\treturn out;\n}\n\n/**\n* Takes elements from a boolean array and assigns the values to elements in a boolean output array.\n*\n* @private\n* @param {Collection} x - boolean value input array view\n* @param {Object} indices - index array object\n* @param {string} mode - index mode\n* @param {Collection} out - boolean value output array view\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array view\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* var x = new Uint8Array( [ 1, 0, 0, 1 ] );\n* var indices = [ 0, 0, 1, 1 ];\n*\n* var out = new Uint8Array( 4 );\n*\n* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 );\n* // returns [ 1, 1, 0, 0 ]\n*/\nfunction boolean( x, indices, mode, out, stride, offset ) {\n\tvar getIndex;\n\tvar idata;\n\tvar iget;\n\tvar max;\n\tvar io;\n\tvar i;\n\tvar j;\n\n\tidata = indices.data;\n\tiget = indices.accessors[ 0 ];\n\n\t// Resolve a function for returning an index according to the specified index mode:\n\tgetIndex = ind( mode );\n\n\t// Resolve the maximum index:\n\tmax = x.length - 1;\n\n\t// Extract each desired element from the provided array...\n\tio = offset;\n\tfor ( i = 0; i < idata.length; i++ ) {\n\t\tj = getIndex( iget( idata, i ), max );\n\t\tout[ io ] = x[ j ];\n\t\tio += stride;\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Takes elements from an array and assigns the values to elements in a provided output array.\n*\n* @param {Collection} x - input array\n* @param {IntegerArray} indices - list of indices\n* @param {string} mode - index mode\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array offset\n* @returns {Collection} output array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n* var indices = [ 3, 1, 2, 0 ];\n*\n* var out = [ 0, 0, 0, 0 ];\n* var arr = assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\nfunction assign( x, indices, mode, out, stride, offset ) {\n\tvar xo;\n\tvar io;\n\tvar oo;\n\n\txo = arraylike2object( x );\n\tio = arraylike2object( indices );\n\too = arraylike2object( out );\n\tif (\n\t\txo.accessorProtocol ||\n\t\tio.accessorProtocol ||\n\t\too.accessorProtocol\n\t) {\n\t\t// Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland...\n\t\tif (\n\t\t\tisComplexDataType( xo.dtype ) &&\n\t\t\tisComplexDataType( oo.dtype )\n\t\t) {\n\t\t\tcomplex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\tif (\n\t\t\tisBooleanDataType( xo.dtype ) &&\n\t\t\tisBooleanDataType( oo.dtype )\n\t\t) {\n\t\t\tboolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessors( xo, io, mode, oo, stride, offset );\n\t\treturn out;\n\t}\n\tindexed( x, indices, mode, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assign;\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* Take elements from an array.\n*\n* @module @stdlib/array-base-take\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = take( x, indices, 'throw' );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import take from '@stdlib/array-base-take';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var out = [ 0, 0, 0, 0, 0, 0 ];\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n*\n* var arr = take.assign( x, indices, 'throw', out, 1, 0 );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* var bool = ( arr === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["take","x","indices","mode","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","assign","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complex","reinterpret","isBooleanDataType","boolean","reinterpretBoolean","xdata","odata","oset","indexed","setReadOnly","main"],"mappings":";;+2BA2CA,SAASA,EAAMC,EAAGC,EAASC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeV,GACtBK,EAAOK,EAAeT,GAGtBE,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUE,EAAMJ,EAASO,GAAKD,GAClCD,EAAIO,KAAMT,EAAMJ,EAAGS,IAEpB,OAAOH,CACR,CC2MA,SAASQ,EAAQd,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAC/C,IAAIC,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBpB,GACvBkB,EAAKE,EAAkBnB,GACvBkB,EAAKC,EAAkBd,GAEtBW,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QA9HzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAO,EACAjB,EAEAkB,EAcJ,IAZAF,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAQP,EAAEY,OAAO,EAAM,EAGvBa,EAAc,EAATV,EACLG,EAAc,EAATF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9BkB,EAAQ,EADJvB,EAAUE,EAAMmB,EAAOhB,GAAKD,GAEhCD,EAAKY,GAAOlB,EAAG0B,GACfpB,EAAKY,EAAG,GAAMlB,EAAG0B,EAAE,GACnBR,GAAMO,CAGR,CAiGGI,CAASC,EAAa9B,EAAG,GAAKkB,EAAIhB,EAAM4B,EAAaxB,EAAK,GAAKS,EAAQC,GAChEV,GAGPyB,EAAmBd,EAAGM,QACtBQ,EAAmBZ,EAAGI,QA5EzB,SAAkBvB,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAqB,EACAnB,EACAE,EACAW,EACAV,EACAC,EAaJ,IAXAe,EAAQvB,EAAQ0B,KAChBtB,EAAOJ,EAAQ2B,UAAW,GAG1BzB,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMmB,EAAOhB,GAAKD,GAChCD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAoDGiB,CAASC,EAAoBjC,EAAG,GAAKkB,EAAIhB,EAAM+B,EAAoB3B,EAAK,GAAKS,EAAQC,GAC9EV,IArMV,SAAoBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAClD,IAAIb,EACA+B,EACAV,EACAW,EACA/B,EACAC,EACA+B,EACA7B,EACAW,EACAV,EAmBJ,IAhBA0B,EAAQlC,EAAE2B,KACVH,EAAQvB,EAAQ0B,KAChBQ,EAAQ7B,EAAIqB,KAEZvB,EAAOJ,EAAE4B,UAAW,GACpBvB,EAAOJ,EAAQ2B,UAAW,GAC1BQ,EAAO9B,EAAIsB,UAAW,GAGtBzB,EAAWQ,EAAKT,GAGhBK,EAAM2B,EAAMtB,OAAS,EAGrBM,EAAKF,EACCR,EAAI,EAAGA,EAAIgB,EAAMZ,OAAQJ,IAE9B4B,EAAMD,EAAOjB,EAAId,EAAM8B,EADnB/B,EAAUE,EAAMmB,EAAOhB,GAAKD,KAEhCW,GAAMH,CAGR,CAoKEa,CAAWX,EAAIC,EAAIhB,EAAMiB,EAAIJ,EAAQC,GAC9BV,IAxPT,SAAkBN,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GAChD,IAAIb,EACAI,EACAW,EACAV,EACAC,EAUJ,IAPAN,EAAWQ,EAAKT,GAGhBK,EAAMP,EAAEY,OAAS,EAGjBM,EAAKF,EACCR,EAAI,EAAGA,EAAIP,EAAQW,OAAQJ,IAChCC,EAAIN,EAAUF,EAASO,GAAKD,GAC5BD,EAAKY,GAAOlB,EAAGS,GACfS,GAAMH,CAGR,CAqOCsB,CAASrC,EAAGC,EAASC,EAAMI,EAAKS,EAAQC,GACjCV,EACR,CCvPAgC,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7c8303a..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,311 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isBooleanDataType = require( '@stdlib/array-base-assert-is-boolean-data-type' ); -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -var reinterpret = require( '@stdlib/strided-base-reinterpret-complex' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// FUNCTIONS // - -/** -* Takes elements from an indexed array and assigns the values to elements in an indexed output array. -* -* @private -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* var arr = indexed( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -*/ -function indexed( x, indices, mode, out, stride, offset ) { - var getIndex; - var max; - var io; - var i; - var j; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( indices[ i ], max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - -/** -* Takes elements from an accessor array and assigns the values to elements in an accessor output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Object} out - output array object -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = toAccessorArray( [ 1, 2, 3, 4 ] ); -* var indices = toAccessorArray( [ 3, 1, 2, 0 ] ); -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessors( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0 ); -* -* var v = arr.get( 0 ); -* // returns 4 -*/ -function accessors( x, indices, mode, out, stride, offset ) { - var getIndex; - var xdata; - var idata; - var odata; - var xget; - var iget; - var oset; - var max; - var io; - var i; - var j; - - xdata = x.data; - idata = indices.data; - odata = out.data; - - xget = x.accessors[ 0 ]; - iget = indices.accessors[ 0 ]; - oset = out.accessors[ 1 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = xdata.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - oset( odata, io, xget( xdata, j ) ); - io += stride; - } - return odata; -} - -/** -* Takes elements from a complex array and assigns the values to elements in a complex output array. -* -* @private -* @param {Collection} x - real-valued floating-point input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - real-valued floating-point output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Float64Array( 8 ); -* -* var arr = complex( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complex( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var so; - var i; - var j; - var k; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = ( x.length/2 ) - 1; // resolve the length of the original complex array - - // Extract each desired element from the provided array... - so = stride * 2; // note: multiply by 2, as real-valued array consists of interleaved real and imaginary components - io = offset * 2; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - k = j * 2; - out[ io ] = x[ k ]; - out[ io+1 ] = x[ k+1 ]; - io += so; - } - return out; -} - -/** -* Takes elements from a boolean array and assigns the values to elements in a boolean output array. -* -* @private -* @param {Collection} x - boolean value input array view -* @param {Object} indices - index array object -* @param {string} mode - index mode -* @param {Collection} out - boolean value output array view -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array view -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* var x = new Uint8Array( [ 1, 0, 0, 1 ] ); -* var indices = [ 0, 0, 1, 1 ]; -* -* var out = new Uint8Array( 4 ); -* -* var arr = boolean( x, arraylike2object( indices ), 'throw', out, 1, 0 ); -* // returns [ 1, 1, 0, 0 ] -*/ -function boolean( x, indices, mode, out, stride, offset ) { - var getIndex; - var idata; - var iget; - var max; - var io; - var i; - var j; - - idata = indices.data; - iget = indices.accessors[ 0 ]; - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - io = offset; - for ( i = 0; i < idata.length; i++ ) { - j = getIndex( iget( idata, i ), max ); - out[ io ] = x[ j ]; - io += stride; - } - return out; -} - - -// MAIN // - -/** -* Takes elements from an array and assigns the values to elements in a provided output array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {Collection} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* var arr = assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -function assign( x, indices, mode, out, stride, offset ) { - var xo; - var io; - var oo; - - xo = arraylike2object( x ); - io = arraylike2object( indices ); - oo = arraylike2object( out ); - if ( - xo.accessorProtocol || - io.accessorProtocol || - oo.accessorProtocol - ) { - // Note: we only explicitly support a limited set of dtype-to-dtype pairs, as this function should not be concerned with casting rules, etc. That is left to userland... - if ( - isComplexDataType( xo.dtype ) && - isComplexDataType( oo.dtype ) - ) { - complex( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - if ( - isBooleanDataType( xo.dtype ) && - isBooleanDataType( oo.dtype ) - ) { - boolean( reinterpretBoolean( x, 0 ), io, mode, reinterpretBoolean( out, 0 ), stride, offset ); // eslint-disable-line max-len - return out; - } - accessors( xo, io, mode, oo, stride, offset ); - return out; - } - indexed( x, indices, mode, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 57d627b..0000000 --- a/lib/index.js +++ /dev/null @@ -1,64 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Take elements from an array. -* -* @module @stdlib/array-base-take -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = take( x, indices, 'throw' ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var take = require( '@stdlib/array-base-take' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* var arr = take.assign( x, indices, 'throw', out, 1, 0 ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* var bool = ( arr === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 563a37d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var y = take( x, indices, 'throw' ); -* // returns [ 4, 2, 3, 1 ] -*/ -function take( x, indices, mode ) { - var getIndex; - var xget; - var iget; - var out; - var max; - var i; - var j; - - // Resolve an accessor for retrieving array elements: - xget = resolveGetter( x ); - iget = resolveGetter( indices ); - - // Resolve a function for returning an index according to the specified index mode: - getIndex = ind( mode ); - - // Resolve the maximum index: - max = x.length - 1; - - // Extract each desired element from the provided array... - out = []; - for ( i = 0; i < indices.length; i++ ) { - j = getIndex( iget( indices, i ), max ); - out.push( xget( x, j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = take; diff --git a/package.json b/package.json index 94a4983..ea7cd50 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.3.1", "description": "Take elements from an array.", "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,60 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.2", - "@stdlib/array-base-assert-is-boolean-data-type": "^0.0.2", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.2", - "@stdlib/array-base-resolve-getter": "^0.2.3", - "@stdlib/ndarray-base-ind": "^0.2.3", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.3", - "@stdlib/strided-base-reinterpret-complex": "^0.1.3", - "@stdlib/types": "^0.5.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-base-linspace": "^0.2.3", - "@stdlib/array-base-to-accessor-array": "^0.2.3", - "@stdlib/array-base-zero-to": "^0.2.2", - "@stdlib/array-bool": "^0.1.2", - "@stdlib/array-complex128": "^0.3.2", - "@stdlib/array-complex64": "^0.3.2", - "@stdlib/array-float64": "^0.2.3", - "@stdlib/array-zeros": "^0.2.3", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-array": "^0.2.3", - "@stdlib/assert-is-complex64": "^0.2.3", - "@stdlib/assert-is-equal-booleanarray": "^0.1.1", - "@stdlib/assert-is-method": "^0.2.3", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/assert-is-same-complex64array": "^0.2.3", - "@stdlib/complex-float32-imag": "^0.1.2", - "@stdlib/complex-float32-real": "^0.1.2", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@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", "utilities", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c7f68bf --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 3d26427..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,676 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var Float64Array = require( '@stdlib/array-float64' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isSameComplex64Array = require( '@stdlib/assert-is-same-complex64array' ); -var isEqualBooleanArray = require( '@stdlib/assert-is-equal-booleanarray' ); -var zeros = require( '@stdlib/array-zeros' ); -var take = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'generic' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'generic' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'generic' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Float64Array( [ 2.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'float64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Float64Array( [ 2.0, 0.0, 2.0, 0.0, 4.0, 0.0, 4.0, 0.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'float64' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'float64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Float64Array( [ 0.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 7.0, 8.0 ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = zeros( indices.length*2, 'complex64' ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new Complex64Array( [ 3.0, 4.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - indices = [ 3, 2, 1, 0 ]; - out = zeros( indices.length, 'complex128' ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = zeros( indices.length+1, 'complex64' ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new Complex64Array( [ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (boolean array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new BooleanArray( [ true, false, false, true ] ); - - indices = [ 1, 3 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = new BooleanArray( [ false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - out = new BooleanArray( indices.length*2 ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = new BooleanArray( [ false, false, false, false, true, false, true, false ] ); // eslint-disable-line max-len - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - out = new BooleanArray( indices.length ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = new BooleanArray( [ true, false, false, true ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - indices = [ 1, 1, 1, 1 ]; - out = new BooleanArray( indices.length+1 ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = new BooleanArray( [ false, false, false, false, false ] ); - - t.strictEqual( actual, out, 'returns expected value' ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 0 ); - expected = [ 2, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = take( x, indices, 'throw', out, 2, 0 ); - expected = [ 2, 0, 2, 0, 4, 0, 4, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = take( x, indices, 'throw', out, -1, out.length-1 ); - expected = [ 1, 2, 3, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ] ); - out = toAccessorArray( zeros( indices.length+1, 'generic' ) ); - actual = take( x, indices, 'throw', out, 1, 1 ); - expected = [ 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - t.end(); - - function isEqual( actual, expected ) { - var i; - for ( i = 0; i < expected.length; i++ ) { - t.strictEqual( actual.get( i ), expected[ i ], 'returns expected value' ); - } - } -}); - -tape( 'the function returns leaves an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = take( x, [], 'throw', out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - expected = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - x = new BooleanArray( [ true, false, false, true ] ); - out = new BooleanArray( [ false, false, false, false ] ); - expected = new BooleanArray( [ false, false, false, false ] ); - actual = take( x, [], 'throw', out, 1, 0 ); - t.strictEqual( isEqualBooleanArray( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index (boolean)', function test( t ) { - var indices; - var out; - var x; - - x = new BooleanArray( [ true, false ] ); - indices = [ 4, 5, 1, 2 ]; - out = new BooleanArray( x.length ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'normalize', toAccessorArray( out ), 1, 0 ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Float64Array( [ 4.0, 3.0, 2.0, 1.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'normalize', out, 1, 0 ); - expected = new Complex128Array( [ 3.0, 4.0, 1.0, 2.0 ] ); - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (generic)', function test( t ) { - var indices; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'generic' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (accessors)', function test( t ) { - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ 4, 5, 1, 2 ] ); - out = toAccessorArray( zeros( x.length, 'generic' ) ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (real typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'float64' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index (complex typed)', function test( t ) { - var indices; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ 4, 5, 1, 2 ]; - out = zeros( x.length, 'complex128' ); - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize', out, 1, 0 ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'clamp', toAccessorArray( out ), 1, 0 ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Float64Array( [ 1.0, 4.0, 1.0, 4.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'clamp', out, 1, 0 ); - expected = new Complex128Array( [ 1.0, 2.0, 7.0, 8.0, 1.0, 2.0, 7.0, 8.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (generic)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (accessors)', function test( t ) { - var expected; - var indices; - var out; - var x; - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - take( x, indices, 'wrap', toAccessorArray( out ), 1, 0 ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (real typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Float64Array( [ 3.0, 3.0, 4.0, 2.0 ] ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices (complex typed)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'complex128' ); - - actual = take( x, indices, 'wrap', out, 1, 0 ); - expected = new Complex128Array( [ 5.0, 6.0, 5.0, 6.0, 7.0, 8.0, 3.0, 4.0 ] ); // eslint-disable-line max-len - t.strictEqual( isSameComplex128Array( actual, expected ), true, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 9dfba3b..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( take, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( take, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b769332..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,189 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var take = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof take, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 4, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = take( x, indices, 'throw' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = take( x, indices, 'throw' ); - expected = [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected ), 'returns expected value' ); - } - - x = new BooleanArray( [ true, false, false, true ] ); - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - actual = take( x, indices, 'throw' ); - - t.notEqual( actual, x, 'returns different reference' ); - for ( i = 0; i < indices.length; i++ ) { - v = actual[ i ]; - expected = x.get( indices.get( i ) ); - t.strictEqual( v, expected, 'returns expected value' ); - } - - t.end(); -}); - -tape( 'the function returns an empty array if provided a second argument which is empty', function test( t ) { - var x = [ 1, 2, 3, 4 ]; - t.deepEqual( take( x, [], 'throw' ), [], 'returns expected value' ); - t.end(); -}); - -tape( 'when the "mode" is "throw", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'throw' ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = take( x, indices, 'normalize' ); - expected = [ 4, 3, 2, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "normalize", the function throws an error if provided an out-of-bounds index', function test( t ) { - var indices; - var x; - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - take( x, indices, 'normalize' ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'clamp' ); - expected = [ 1, 4, 1, 4 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'when the "mode" is "wrap", the function wraps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = take( x, indices, 'wrap' ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -});