From 72e2f9e43dd28e1c95b45c8fc0982c6626f5ef43 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 6 Mar 2024 15:30:11 +0000 Subject: [PATCH 01/83] Transform error messages --- lib/index.js | 4 ++-- package.json | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/index.js b/lib/index.js index 76a9991..a096ffd 100644 --- a/lib/index.js +++ b/lib/index.js @@ -29,7 +29,7 @@ * var x = [ 1, 2, 3, 4 ]; * * function mapFunction( val ) { - return val; + return val; } * * var indices = [ 0, 0, 1, 1, 3, 3 ]; @@ -45,7 +45,7 @@ * var indices = [ 0, 0, 1, 1, 3, 3 ]; * * function clbk( val ) { - return val; + return val; } * * var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); diff --git a/package.json b/package.json index d5460fb..4dcec52 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 be8659ea52b86401d8fe76e4b6375b76de1fed42 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 6 Mar 2024 15:31:26 +0000 Subject: [PATCH 02/83] 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 | 229 - .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 | 109 - benchmark/benchmark.js | 56 - benchmark/benchmark.length.js | 102 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 -- lib/index.js | 72 - lib/main.js | 82 - package.json | 79 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 47 files changed, 4874 insertions(+), 5250 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 (98%) 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 8362795..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 7725e9b..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,109 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 e5c92e7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,56 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 0189388..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,102 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk);\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n return val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n return val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAKM,EAAI,EAAGA,EAAEP,EAAI,OAAQO,IAEzBP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACAK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC7BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c4b02a9..5cf0ee4 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a4b43d6 --- /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 l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk);\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 037d45f..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for (i = 0; i[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index a096ffd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { - return val; -} -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { - return val; -} -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index 4dcec52..027c342 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Take elements from an array and return a new array after applying a mapping function.", "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..4e62963 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 6854a55..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 29294370b647e0c7907e3942cc21286634927b70 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 08:28:46 +0000 Subject: [PATCH 03/83] Transform error messages --- lib/index.js | 4 ++-- package.json | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/index.js b/lib/index.js index 76a9991..a096ffd 100644 --- a/lib/index.js +++ b/lib/index.js @@ -29,7 +29,7 @@ * var x = [ 1, 2, 3, 4 ]; * * function mapFunction( val ) { - return val; + return val; } * * var indices = [ 0, 0, 1, 1, 3, 3 ]; @@ -45,7 +45,7 @@ * var indices = [ 0, 0, 1, 1, 3, 3 ]; * * function clbk( val ) { - return val; + return val; } * * var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); diff --git a/package.json b/package.json index d5460fb..4dcec52 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 59eb1885b9683c2d3db34beb8f98abaeba570fa6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 14:07:21 +0000 Subject: [PATCH 04/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 5cf0ee4..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a4b43d6..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 l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk);\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 4e62963..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From cced0cfabb77080f8dbc1c7e4b7d61cc4f00c442 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 14:07:47 +0000 Subject: [PATCH 05/83] 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 | 109 - benchmark/benchmark.js | 56 - benchmark/benchmark.length.js | 102 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 -- lib/index.js | 72 - lib/main.js | 82 - package.json | 79 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 48 files changed, 4874 insertions(+), 5254 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 (98%) 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 957c300..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-04-01T05:52:39.858Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8362795..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 7725e9b..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,109 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 e5c92e7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,56 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 0189388..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,102 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk);\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n return val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n return val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAKM,EAAI,EAAGA,EAAEP,EAAI,OAAQO,IAEzBP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACAK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC7BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c4b02a9..5cf0ee4 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a4b43d6 --- /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 l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk);\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 037d45f..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for (i = 0; i[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index a096ffd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { - return val; -} -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { - return val; -} -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index 4dcec52..027c342 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Take elements from an array and return a new array after applying a mapping function.", "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..4e62963 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 6854a55..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 130dec240def566a795c89d8a6b1b7d1967e7057 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 04:37:06 +0000 Subject: [PATCH 06/83] Transform error messages --- lib/index.js | 4 ++-- package.json | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/index.js b/lib/index.js index 76a9991..a096ffd 100644 --- a/lib/index.js +++ b/lib/index.js @@ -29,7 +29,7 @@ * var x = [ 1, 2, 3, 4 ]; * * function mapFunction( val ) { - return val; + return val; } * * var indices = [ 0, 0, 1, 1, 3, 3 ]; @@ -45,7 +45,7 @@ * var indices = [ 0, 0, 1, 1, 3, 3 ]; * * function clbk( val ) { - return val; + return val; } * * var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); diff --git a/package.json b/package.json index d5460fb..4dcec52 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 f890daf234de9b7a6f4d61df0a6539698b15c00b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 10:18:53 +0000 Subject: [PATCH 07/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 5cf0ee4..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a4b43d6..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 l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk);\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 4e62963..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 28397e461785ecca905abfba0820585ecdc88ce9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 10:19:14 +0000 Subject: [PATCH 08/83] 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 | 109 - benchmark/benchmark.js | 56 - benchmark/benchmark.length.js | 102 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 -- lib/index.js | 72 - lib/main.js | 82 - package.json | 79 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 47 files changed, 4874 insertions(+), 5255 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 (98%) 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 8362795..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 7725e9b..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,109 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 e5c92e7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,56 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 0189388..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,102 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk);\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n return val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n return val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAKM,EAAI,EAAGA,EAAEP,EAAI,OAAQO,IAEzBP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACAK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC7BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c4b02a9..5cf0ee4 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a4b43d6 --- /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 l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk);\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 037d45f..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for (i = 0; i[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index a096ffd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { - return val; -} -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { - return val; -} -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index 4dcec52..027c342 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Take elements from an array and return a new array after applying a mapping function.", "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..4e62963 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 6854a55..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 895d43cc9f06901da264f72f5fcd989921e14005 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 13 Apr 2024 01:54:52 +0000 Subject: [PATCH 09/83] Transform error messages --- lib/index.js | 4 ++-- package.json | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/index.js b/lib/index.js index 76a9991..a096ffd 100644 --- a/lib/index.js +++ b/lib/index.js @@ -29,7 +29,7 @@ * var x = [ 1, 2, 3, 4 ]; * * function mapFunction( val ) { - return val; + return val; } * * var indices = [ 0, 0, 1, 1, 3, 3 ]; @@ -45,7 +45,7 @@ * var indices = [ 0, 0, 1, 1, 3, 3 ]; * * function clbk( val ) { - return val; + return val; } * * var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); diff --git a/package.json b/package.json index f486b1c..9a82f40 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 477ee9cbb609c2b244b6d042579ea8313a658163 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 13 Apr 2024 02:20:26 +0000 Subject: [PATCH 10/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 5cf0ee4..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a4b43d6..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 l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk);\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 4e62963..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e8fb1a0e998ff59ae3a082b3263937d8cc9d34fb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 13 Apr 2024 02:20:44 +0000 Subject: [PATCH 11/83] 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 | 794 ---- .github/workflows/publish.yml | 248 -- .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 | 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 | 109 - benchmark/benchmark.js | 56 - benchmark/benchmark.length.js | 102 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 -- lib/index.js | 72 - lib/main.js | 82 - package.json | 79 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 47 files changed, 4874 insertions(+), 5245 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 (98%) 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 8362795..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 7725e9b..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,109 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 e5c92e7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,56 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 0189388..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,102 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk);\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n return val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n return val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAKM,EAAI,EAAGA,EAAEP,EAAI,OAAQO,IAEzBP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACAK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC7BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c4b02a9..5cf0ee4 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a4b43d6 --- /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 l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk);\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 037d45f..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for (i = 0; i[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index a096ffd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { - return val; -} -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { - return val; -} -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index 9a82f40..68d0009 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Take elements from an array and return a new array after applying a mapping function.", "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..4e62963 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 6854a55..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From fb4c90aeecf022947dfd27eb6d08d4116989df8b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 13 Apr 2024 02:24:52 +0000 Subject: [PATCH 12/83] Update README.md for ESM bundle v0.1.0 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ed152cd..67f0498 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@esm/index.mjs'; +import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v0.1.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-map@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v0.1.0-esm/index.mjs'; ``` ### takeMap( x, indices, mode, clbk ) @@ -129,7 +129,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 takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@esm/index.mjs'; +import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v0.1.0-esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From 8411484e034103f2262a53426c44164103f085a0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 13 Apr 2024 02:24:53 +0000 Subject: [PATCH 13/83] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 67f0498..ba8e62b 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,11 @@ limitations under the License. ## Usage +```javascript +import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@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-map/tags). For example, + ```javascript import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v0.1.0-esm/index.mjs'; ``` @@ -48,7 +53,7 @@ import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v 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-map@v0.1.0-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@esm/index.mjs'; ``` ### takeMap( x, indices, mode, clbk ) @@ -129,7 +134,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 takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v0.1.0-esm/index.mjs'; +import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From d387c3f690a29be6aa377700d08b2729217aabd0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jul 2024 17:01:45 +0000 Subject: [PATCH 14/83] Transform error messages --- lib/index.js | 4 ++-- package.json | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/index.js b/lib/index.js index 76a9991..a096ffd 100644 --- a/lib/index.js +++ b/lib/index.js @@ -29,7 +29,7 @@ * var x = [ 1, 2, 3, 4 ]; * * function mapFunction( val ) { - return val; + return val; } * * var indices = [ 0, 0, 1, 1, 3, 3 ]; @@ -45,7 +45,7 @@ * var indices = [ 0, 0, 1, 1, 3, 3 ]; * * function clbk( val ) { - return val; + return val; } * * var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); diff --git a/package.json b/package.json index f486b1c..9a82f40 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 c25f75744bd117874e40d156a374978b278405b9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jul 2024 17:02:28 +0000 Subject: [PATCH 15/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 5cf0ee4..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a4b43d6..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 l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk);\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 4e62963..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 9fe89235a68716c9145a5fa3ceafa00bf4a29e22 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jul 2024 17:02:58 +0000 Subject: [PATCH 16/83] 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 | 83 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 109 - benchmark/benchmark.js | 56 - benchmark/benchmark.length.js | 102 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 -- lib/index.js | 72 - lib/main.js | 82 - package.json | 79 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 47 files changed, 4874 insertions(+), 5344 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 (98%) 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 8362795..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 7725e9b..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,109 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 e5c92e7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,56 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 0189388..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,102 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n return val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n return val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAKM,EAAI,EAAGA,EAAEP,EAAI,OAAQO,IAEzBP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACAK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC7BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c4b02a9..5cf0ee4 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a4b43d6 --- /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 l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index a8ebe4d..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for (i = 0; i[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index a096ffd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { - return val; -} -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { - return val; -} -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index 9a82f40..68d0009 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Take elements from an array and return a new array after applying a mapping function.", "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..b0a801c --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 6854a55..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From c3739ddc814d69ffae530fc28d97786ee3872211 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 17 Jul 2024 03:27:46 +0000 Subject: [PATCH 17/83] Transform error messages --- lib/index.js | 4 ++-- package.json | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/index.js b/lib/index.js index 76a9991..a096ffd 100644 --- a/lib/index.js +++ b/lib/index.js @@ -29,7 +29,7 @@ * var x = [ 1, 2, 3, 4 ]; * * function mapFunction( val ) { - return val; + return val; } * * var indices = [ 0, 0, 1, 1, 3, 3 ]; @@ -45,7 +45,7 @@ * var indices = [ 0, 0, 1, 1, 3, 3 ]; * * function clbk( val ) { - return val; + return val; } * * var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); diff --git a/package.json b/package.json index 87161a5..acd6c10 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 2badc99b7ed40b92445b5bff2e2472f4e2f8e271 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 17 Jul 2024 03:37:40 +0000 Subject: [PATCH 18/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 5cf0ee4..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a4b43d6..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 l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index b0a801c..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 183ebe361af3682ed85ff5efb087e692702ef002 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 17 Jul 2024 03:38:01 +0000 Subject: [PATCH 19/83] 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 | 86 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 109 - benchmark/benchmark.js | 56 - benchmark/benchmark.length.js | 102 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 -- lib/index.js | 72 - lib/main.js | 82 - package.json | 79 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 47 files changed, 4874 insertions(+), 5347 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 (98%) 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 8362795..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 7725e9b..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,109 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 e5c92e7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,56 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 0189388..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,102 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n return val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n return val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAKM,EAAI,EAAGA,EAAEP,EAAI,OAAQO,IAEzBP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACAK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC7BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c4b02a9..5cf0ee4 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a4b43d6 --- /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 l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index a8ebe4d..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for (i = 0; i[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index a096ffd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { - return val; -} -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { - return val; -} -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index acd6c10..68d0009 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Take elements from an array and return a new array after applying a mapping function.", "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-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", @@ -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..b0a801c --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 22a9462bb84d019429969263e6adad7d1a9c1a51 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 11:52:41 +0000 Subject: [PATCH 20/83] Transform error messages --- lib/index.js | 4 ++-- package.json | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/index.js b/lib/index.js index 76a9991..a096ffd 100644 --- a/lib/index.js +++ b/lib/index.js @@ -29,7 +29,7 @@ * var x = [ 1, 2, 3, 4 ]; * * function mapFunction( val ) { - return val; + return val; } * * var indices = [ 0, 0, 1, 1, 3, 3 ]; @@ -45,7 +45,7 @@ * var indices = [ 0, 0, 1, 1, 3, 3 ]; * * function clbk( val ) { - return val; + return val; } * * var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); diff --git a/package.json b/package.json index bf2316c..ee0105e 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.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", @@ -100,4 +101,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From f0628c30769ce11d03a781465ad76c1a44212851 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 11:53:26 +0000 Subject: [PATCH 21/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 5cf0ee4..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a4b43d6..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 l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.1-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index b0a801c..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 9cc12dc3cefab7a551f6f0afb1f2a2485b4f51ec Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 11:53:41 +0000 Subject: [PATCH 22/83] 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 | 86 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 109 - benchmark/benchmark.js | 56 - benchmark/benchmark.length.js | 102 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 -- lib/index.js | 72 - lib/main.js | 82 - package.json | 79 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 47 files changed, 4874 insertions(+), 5349 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 (98%) 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 8362795..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 7725e9b..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,109 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 e5c92e7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,56 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 0189388..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,102 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n return val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n return val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAKM,EAAI,EAAGA,EAAEP,EAAI,OAAQO,IAEzBP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACAK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC7BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c4b02a9..5cf0ee4 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..853fd1b --- /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.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index a8ebe4d..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for (i = 0; i[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index a096ffd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { - return val; -} -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { - return val; -} -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index ee0105e..0ae979e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.2", - "@stdlib/ndarray-base-ind": "^0.2.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-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-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", @@ -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..b9c29b4 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From edaf0cd82cc21955349426f9f11da9d0ff54c96d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 11:54:16 +0000 Subject: [PATCH 23/83] Update README.md for ESM bundle v0.1.1 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9beef36..821764e 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@esm/index.mjs'; +import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v0.1.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-map@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v0.1.1-esm/index.mjs'; ``` ### takeMap( x, indices, mode, clbk ) @@ -129,7 +129,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 takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@esm/index.mjs'; +import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v0.1.1-esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From 04de7f55668b3ab94cefec461e9cee879efa3f62 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 11:54:17 +0000 Subject: [PATCH 24/83] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 821764e..99314c1 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,11 @@ limitations under the License. ## Usage +```javascript +import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@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-map/tags). For example, + ```javascript import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v0.1.1-esm/index.mjs'; ``` @@ -48,7 +53,7 @@ import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v 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-map@v0.1.1-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@esm/index.mjs'; ``` ### takeMap( x, indices, mode, clbk ) @@ -129,7 +134,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 takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v0.1.1-esm/index.mjs'; +import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From a6b5ebd2ccceddcb4a2af8932b42fcc5d1162dc3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Dec 2024 01:43:51 +0000 Subject: [PATCH 25/83] Transform error messages --- lib/index.js | 4 ++-- package.json | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/index.js b/lib/index.js index 76a9991..a096ffd 100644 --- a/lib/index.js +++ b/lib/index.js @@ -29,7 +29,7 @@ * var x = [ 1, 2, 3, 4 ]; * * function mapFunction( val ) { - return val; + return val; } * * var indices = [ 0, 0, 1, 1, 3, 3 ]; @@ -45,7 +45,7 @@ * var indices = [ 0, 0, 1, 1, 3, 3 ]; * * function clbk( val ) { - return val; + return val; } * * var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); diff --git a/package.json b/package.json index f4b6569..abdcf3b 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.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", @@ -100,4 +101,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From cff055fc5899e51f47abd1c57621aa41e287e187 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Dec 2024 01:55:33 +0000 Subject: [PATCH 26/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 5cf0ee4..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 853fd1b..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.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index b9c29b4..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 70dacecda58a2501a9da5e8905beae4a511666b8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Dec 2024 01:55:58 +0000 Subject: [PATCH 27/83] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 86 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 109 - benchmark/benchmark.js | 56 - benchmark/benchmark.length.js | 102 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 79 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 49 files changed, 4874 insertions(+), 5455 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 (98%) 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 0779e8a..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 = 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 d83d321..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-12-23T01:40:29.905Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8362795..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 7725e9b..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,109 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 e5c92e7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,56 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 0189388..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,102 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n return val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n return val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAKM,EAAI,EAAGA,EAAEP,EAAI,OAAQO,IAEzBP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACAK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC7BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c4b02a9..5cf0ee4 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..853fd1b --- /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.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index a8ebe4d..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for (i = 0; i[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index a096ffd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { - return val; -} -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { - return val; -} -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index abdcf3b..0ae979e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.2", - "@stdlib/ndarray-base-ind": "^0.2.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-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-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", @@ -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..b9c29b4 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 38db37a46397bc16ffdeb11f6a4af1b047e7bfb9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Dec 2024 20:21:03 +0000 Subject: [PATCH 28/83] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index f4b6569..abdcf3b 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.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", @@ -100,4 +101,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 9a85f2d0cb6ddf367027707ad4b2ba4733ed72d2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Dec 2024 20:21:28 +0000 Subject: [PATCH 29/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 5cf0ee4..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 853fd1b..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.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n\treturn val;\n}\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n\treturn val;\n}\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index b9c29b4..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 7a11fca3bdb32bb317e09baf848ec6429b72bc05 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Dec 2024 20:22:12 +0000 Subject: [PATCH 30/83] 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 - .github/workflows/test_published_package.yml | 105 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 120 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 109 - benchmark/benchmark.js | 56 - benchmark/benchmark.length.js | 102 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 79 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 48 files changed, 4874 insertions(+), 5488 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 (98%) 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 0779e8a..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 = 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 8362795..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 7725e9b..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,109 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 e5c92e7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,56 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 0189388..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,102 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAKM,EAAI,EAAGA,EAAEP,EAAI,OAAQO,IAEzBP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACAK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC7BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c4b02a9..5cf0ee4 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..853fd1b --- /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.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index a8ebe4d..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for (i = 0; i[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index abdcf3b..0ae979e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.2", - "@stdlib/ndarray-base-ind": "^0.2.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-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-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", @@ -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..b9c29b4 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From c49bf2a35b4aa118c70e787cd9548913f2d4db56 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 24 Dec 2024 20:12:24 +0000 Subject: [PATCH 31/83] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index f4b6569..abdcf3b 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.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", @@ -100,4 +101,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From b54544773728cd91f3b702e9f12c6796dc0821f0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 24 Dec 2024 20:12:47 +0000 Subject: [PATCH 32/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 5cf0ee4..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 853fd1b..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.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACAT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC7BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAKR,EAAI,EAAGA,EAAEF,EAAIM,OAAQJ,IAEzBF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index b9c29b4..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 268b53d068d7bd29b8659fe0cb7e4849ccb1c28f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 24 Dec 2024 20:13:10 +0000 Subject: [PATCH 33/83] 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 - .github/workflows/test_published_package.yml | 105 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 121 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 109 - benchmark/benchmark.js | 56 - benchmark/benchmark.length.js | 102 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 79 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 48 files changed, 4874 insertions(+), 5489 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 (98%) 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 0779e8a..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 = 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 8362795..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 7725e9b..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,109 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 e5c92e7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,56 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 0189388..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,102 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c4b02a9..5cf0ee4 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..853fd1b --- /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.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index abdcf3b..0ae979e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.2", - "@stdlib/ndarray-base-ind": "^0.2.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-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-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", @@ -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..2db2540 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From b3af10f22b8d8142218e2bf0199b06b5b7ef595b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 30 Dec 2024 03:17:05 +0000 Subject: [PATCH 34/83] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index f4b6569..abdcf3b 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.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", @@ -100,4 +101,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 41a168f049b857897d5289734ec0c3ce51bc171d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 30 Dec 2024 04:29:46 +0000 Subject: [PATCH 35/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 5cf0ee4..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 853fd1b..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.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2db2540..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e014f1f8d6ae5fb61f26e5c15d60cf85ff34c9de Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 30 Dec 2024 04:30:09 +0000 Subject: [PATCH 36/83] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 121 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 109 - benchmark/benchmark.js | 56 - benchmark/benchmark.length.js | 102 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 79 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 49 files changed, 4874 insertions(+), 5490 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 (98%) 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 0779e8a..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 = 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 8ceadbe..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-12-30T02:49:19.981Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8362795..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 7725e9b..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,109 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 e5c92e7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,56 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 0189388..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,102 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c4b02a9..5cf0ee4 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..853fd1b --- /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.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index abdcf3b..0ae979e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.2", - "@stdlib/ndarray-base-ind": "^0.2.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-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-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", @@ -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..2db2540 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 52e727c0a7fff058439b91d2ca22a1a1e41a8190 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Mar 2025 00:33:03 +0000 Subject: [PATCH 37/83] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index f4b6569..abdcf3b 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.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", @@ -100,4 +101,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 2467abbdaaac9e9778df41f6578bc122f3dfa980 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Mar 2025 00:41:50 +0000 Subject: [PATCH 38/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 5cf0ee4..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 853fd1b..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.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2db2540..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 5b84c5de988ee3b9ae098c939ab72e0dc2f418a8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Mar 2025 00:42:20 +0000 Subject: [PATCH 39/83] 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 | 121 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 109 - benchmark/benchmark.js | 56 - benchmark/benchmark.length.js | 102 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 79 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 49 files changed, 4874 insertions(+), 5493 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 (98%) 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 b0e65cc..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-03-10T00:31:29.845Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index caac4ea..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 7725e9b..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,109 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 e5c92e7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,56 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 0189388..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,102 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c4b02a9..5cf0ee4 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..365d803 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index abdcf3b..0ae979e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.2", - "@stdlib/ndarray-base-ind": "^0.2.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-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-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", @@ -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..2db2540 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 4ef4194728a58455d19896d1cf120f0fccb982ba Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 17 Mar 2025 01:58:58 +0000 Subject: [PATCH 40/83] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index f4b6569..abdcf3b 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.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", @@ -100,4 +101,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 3487a27443e5e478dafd7ae19adb48c072224e1c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 17 Mar 2025 02:10:10 +0000 Subject: [PATCH 41/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 5cf0ee4..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 365d803..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2db2540..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From c6c7d9b635bebe67d3606f956ed8da461494f784 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 17 Mar 2025 02:10:43 +0000 Subject: [PATCH 42/83] 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 | 121 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 109 - benchmark/benchmark.js | 56 - benchmark/benchmark.length.js | 102 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 79 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 49 files changed, 4874 insertions(+), 5493 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 (98%) 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 02c3a08..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-03-17T01:40:37.527Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index caac4ea..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 7725e9b..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,109 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 e5c92e7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,56 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 0189388..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,102 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c4b02a9..5cf0ee4 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..365d803 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index abdcf3b..0ae979e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.2", - "@stdlib/ndarray-base-ind": "^0.2.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-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-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", @@ -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..2db2540 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From bfb9393381c4c76977839ccc89d851aee6f79aeb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 11 Aug 2025 00:50:08 +0000 Subject: [PATCH 43/83] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index f4b6569..abdcf3b 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.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", @@ -100,4 +101,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 4bdd7eb4e38801d1aa1b1ab72dda7c7bbbcbcc9d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 11 Aug 2025 00:58:37 +0000 Subject: [PATCH 44/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 5cf0ee4..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 365d803..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2db2540..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From f43c554ce72a0e4225f50fdcd53cd6911f74262b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 11 Aug 2025 00:59:10 +0000 Subject: [PATCH 45/83] 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 | 121 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 109 - benchmark/benchmark.js | 56 - benchmark/benchmark.length.js | 102 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 79 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 49 files changed, 4874 insertions(+), 5493 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 (98%) 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 41bdd1c..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-08-11T00:48:03.376Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index caac4ea..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 7725e9b..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,109 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 e5c92e7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,56 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 0189388..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,102 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c4b02a9..5cf0ee4 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..365d803 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index abdcf3b..0ae979e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.2", - "@stdlib/ndarray-base-ind": "^0.2.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-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-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", @@ -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..2db2540 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 9b488c52a3367561a9db073cf0f4da21a16b912a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 21 Sep 2025 17:45:58 +0000 Subject: [PATCH 46/83] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index f4b6569..abdcf3b 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-ind": "^0.2.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", @@ -100,4 +101,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 63192b6b5ce5249a6500afecc7555abe805449fd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 21 Sep 2025 17:47:02 +0000 Subject: [PATCH 47/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 5cf0ee4..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 365d803..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2db2540..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 39a5933bde32cd5494c810b58d2fd8e96935611a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 21 Sep 2025 17:47:21 +0000 Subject: [PATCH 48/83] 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 | 122 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 109 - benchmark/benchmark.js | 56 - benchmark/benchmark.length.js | 102 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 79 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 48 files changed, 4874 insertions(+), 5498 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 (98%) 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 caac4ea..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 7725e9b..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,109 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 e5c92e7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,56 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::copy:len=100', function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 0189388..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,102 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 211a141..8833844 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..365d803 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index abdcf3b..0ae979e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.2", - "@stdlib/ndarray-base-ind": "^0.2.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-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-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", @@ -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..2db2540 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From a90444824d28c3019784b1a5edc6ade2f3a6236e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 16 Dec 2025 06:59:10 +0000 Subject: [PATCH 49/83] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 066fcf0..dd77f2d 100644 --- a/package.json +++ b/package.json @@ -65,7 +65,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 be1bbcc7ce01dea4f32e9904359f2c3b96e9a11f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 16 Dec 2025 06:59:36 +0000 Subject: [PATCH 50/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 8833844..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 365d803..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2db2540..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 04483069f51e456f909a0c5f483557b6c8c268f1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 16 Dec 2025 07:00:04 +0000 Subject: [PATCH 51/83] 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 | 124 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 110 - benchmark/benchmark.js | 57 - benchmark/benchmark.length.js | 103 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 77 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 48 files changed, 4873 insertions(+), 5502 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 (98%) 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 caac4ea..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 a6a8379..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,110 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 817c1a1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,57 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 d30a764..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,103 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 211a141..8833844 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..365d803 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index dd77f2d..0ae979e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.2", - "@stdlib/ndarray-base-ind": "^0.2.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-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-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..2db2540 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From c7f7a44694a27894df6b9db7b38c91cf62ed2ef9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Dec 2025 00:46:33 +0000 Subject: [PATCH 52/83] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 066fcf0..dd77f2d 100644 --- a/package.json +++ b/package.json @@ -65,7 +65,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 0e80d302950231644bd07bb566569d3f377f2849 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Dec 2025 00:48:00 +0000 Subject: [PATCH 53/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 8833844..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 365d803..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2db2540..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e4182fcbf3c89d3ba6e93c510a40c5ab0a707c9e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Dec 2025 00:48:18 +0000 Subject: [PATCH 54/83] 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 | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 124 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 110 - benchmark/benchmark.js | 57 - benchmark/benchmark.length.js | 103 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 77 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 49 files changed, 4873 insertions(+), 5503 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 (98%) 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 6bf217d..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-12-29T00:45:39.728Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index caac4ea..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 a6a8379..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,110 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 817c1a1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,57 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 d30a764..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,103 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 211a141..8833844 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..365d803 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index dd77f2d..0ae979e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.2", - "@stdlib/ndarray-base-ind": "^0.2.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-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-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..2db2540 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 7d09c990764e449b7f46d4686fbbd8174f1f8395 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 10 Jan 2026 06:38:40 +0000 Subject: [PATCH 55/83] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 066fcf0..dd77f2d 100644 --- a/package.json +++ b/package.json @@ -65,7 +65,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 bef5c08af5a905d413e1689e4f294bfb757da000 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 10 Jan 2026 06:39:24 +0000 Subject: [PATCH 56/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 8833844..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 365d803..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2db2540..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 99edbf53157fb62abb22848ffac81e44523fb7f5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 10 Jan 2026 06:39:40 +0000 Subject: [PATCH 57/83] 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 | 125 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 110 - benchmark/benchmark.js | 57 - benchmark/benchmark.length.js | 103 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 77 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 48 files changed, 4873 insertions(+), 5603 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 (98%) 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 caac4ea..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 a6a8379..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,110 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 817c1a1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,57 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 d30a764..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,103 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c1a9a9d..3be1c93 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7a3548d --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index dd77f2d..0ae979e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.2", - "@stdlib/ndarray-base-ind": "^0.2.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-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-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..2db2540 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 120eaa70eae48880dbd6df6ab181fb4fe223a128 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 06:22:08 +0000 Subject: [PATCH 58/83] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 19eab18..3534006 100644 --- a/package.json +++ b/package.json @@ -65,7 +65,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 bf8923b96cc7e20cb2ee2679d09d1957fba515e6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 07:07:46 +0000 Subject: [PATCH 59/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 3be1c93..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7a3548d..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2db2540..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From dd483138b95c7d90798a0e775d22f0a6dbc7876c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 07:08:07 +0000 Subject: [PATCH 60/83] 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 | 125 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 110 - benchmark/benchmark.js | 57 - benchmark/benchmark.length.js | 103 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 77 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 48 files changed, 4873 insertions(+), 5603 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 (98%) 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 caac4ea..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 a6a8379..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,110 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 817c1a1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,57 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 d30a764..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,103 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c1a9a9d..3be1c93 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7a3548d --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index 3534006..0ae979e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.2", - "@stdlib/ndarray-base-ind": "^0.2.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-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-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..2db2540 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From f5d8cbed6cbbb0069353604cb7a9bd291ae98149 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 21:38:34 +0000 Subject: [PATCH 61/83] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 1b2c1e4..50c889c 100644 --- a/package.json +++ b/package.json @@ -65,7 +65,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 e9d7be8efc66531460ff677415b7ed7ebb9ccd46 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 22:44:35 +0000 Subject: [PATCH 62/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 3be1c93..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7a3548d..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.2-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2db2540..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e467f7646dd78a4a313383c965ed570c7a1b6d28 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 22:45:04 +0000 Subject: [PATCH 63/83] 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 | 125 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 110 - benchmark/benchmark.js | 57 - benchmark/benchmark.length.js | 103 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 77 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 48 files changed, 4873 insertions(+), 5596 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 (98%) 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 caac4ea..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 a6a8379..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,110 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 817c1a1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,57 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 d30a764..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,103 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c1a9a9d..3be1c93 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..38cec33 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index 50c889c..38a8174 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.2", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.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-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-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-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..a8fc9a8 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From bffadd77ad690ab4bb22b633422f5692433bfef6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 23:04:06 +0000 Subject: [PATCH 64/83] Update README.md for ESM bundle v0.1.2 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 67496c4..3348ef3 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@esm/index.mjs'; +import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v0.1.2-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-map@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v0.1.2-esm/index.mjs'; ``` ### takeMap( x, indices, mode, clbk ) @@ -129,7 +129,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 takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@esm/index.mjs'; +import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v0.1.2-esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From d20b2583ca94369ea01a03f4d26d4a9ea5fe35f9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 23:04:06 +0000 Subject: [PATCH 65/83] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3348ef3..28acb46 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,11 @@ limitations under the License. ## Usage +```javascript +import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@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-map/tags). For example, + ```javascript import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v0.1.2-esm/index.mjs'; ``` @@ -48,7 +53,7 @@ import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v 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-map@v0.1.2-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@esm/index.mjs'; ``` ### takeMap( x, indices, mode, clbk ) @@ -129,7 +134,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 takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@v0.1.2-esm/index.mjs'; +import takeMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-map@esm/index.mjs'; // Generate a linearly spaced array: var x = linspace( 0, 100, 11 ); From 358dcc64911378bf39dca4b0e73e96073868f21c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 16 Feb 2026 02:32:12 +0000 Subject: [PATCH 66/83] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 4bcbc0e..7615537 100644 --- a/package.json +++ b/package.json @@ -65,7 +65,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 97f5304b14357cf29c7b5ffe76ff5929abcc4586 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 16 Feb 2026 03:55:03 +0000 Subject: [PATCH 67/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 3be1c93..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 38cec33..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a8fc9a8..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 6216d085d9ee77594f04c91dc57bef2bcdd5bce4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 16 Feb 2026 03:55:26 +0000 Subject: [PATCH 68/83] 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 | 125 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 110 - benchmark/benchmark.js | 57 - benchmark/benchmark.length.js | 103 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 77 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 49 files changed, 4873 insertions(+), 5597 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 (98%) 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 4d132a7..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-02-16T02:04:54.640Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index caac4ea..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 a6a8379..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,110 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 817c1a1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,57 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 d30a764..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,103 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c1a9a9d..3be1c93 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..38cec33 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index 7615537..38a8174 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.2", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.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-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-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-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..a8fc9a8 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From a2d9ef15679c89c06c61cde8f789b5c9c0226e19 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 8 Apr 2026 03:53:58 +0000 Subject: [PATCH 69/83] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 4bcbc0e..7615537 100644 --- a/package.json +++ b/package.json @@ -65,7 +65,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 017713561fb32c41258a3c6fd4334bdce8950ab4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 8 Apr 2026 04:08:17 +0000 Subject: [PATCH 70/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 3be1c93..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 38cec33..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a8fc9a8..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From ec5e062eba6b3ee13f74905ec213db9da502624a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 8 Apr 2026 04:08:35 +0000 Subject: [PATCH 71/83] 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 | 125 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 110 - benchmark/benchmark.js | 57 - benchmark/benchmark.length.js | 103 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 77 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 49 files changed, 4873 insertions(+), 5608 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 (98%) 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 8db90d2..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-04-08T03:44:30.066Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index caac4ea..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 a6a8379..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,110 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 817c1a1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,57 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 d30a764..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,103 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c1a9a9d..3be1c93 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..38cec33 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index 7615537..38a8174 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.2", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.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-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-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-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..a8fc9a8 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From b825f744fa69f5e533e4d2bc262083007ff860d3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 16 May 2026 03:47:52 +0000 Subject: [PATCH 72/83] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 4bcbc0e..7615537 100644 --- a/package.json +++ b/package.json @@ -65,7 +65,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 9c74bcecc28ba8047686b82e5ba5fb6da4fd2637 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 16 May 2026 04:01:03 +0000 Subject: [PATCH 73/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 3be1c93..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 38cec33..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a8fc9a8..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 3fb5dd5fd6357a5717c0b9cb8c2cb20a8099d416 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 16 May 2026 04:01:21 +0000 Subject: [PATCH 74/83] 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 | 125 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 110 - benchmark/benchmark.js | 57 - benchmark/benchmark.length.js | 103 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 77 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 49 files changed, 4873 insertions(+), 5613 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 (98%) 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 76589a4..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-05-16T03:39:58.869Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index caac4ea..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 a6a8379..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,110 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 817c1a1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,57 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 d30a764..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,103 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c1a9a9d..3be1c93 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..38cec33 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index 7615537..38a8174 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.2", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.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-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-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-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..a8fc9a8 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From f66540210ecc92828c3d24c064d0a1e692f8af7e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 19 May 2026 03:49:39 +0000 Subject: [PATCH 75/83] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 4bcbc0e..7615537 100644 --- a/package.json +++ b/package.json @@ -65,7 +65,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 c2550a55aadf13c6c34a0c98d6b4b01f997f0021 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 19 May 2026 04:00:49 +0000 Subject: [PATCH 76/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 3be1c93..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 38cec33..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a8fc9a8..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 4ab9fd196eb8e746264255c21852087b7edb6319 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 19 May 2026 04:01:07 +0000 Subject: [PATCH 77/83] 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 | 125 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 110 - benchmark/benchmark.js | 57 - benchmark/benchmark.length.js | 103 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 77 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 49 files changed, 4873 insertions(+), 5613 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 (98%) 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 2ee4791..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-05-19T03:42:55.460Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index caac4ea..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 a6a8379..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,110 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 817c1a1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,57 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 d30a764..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,103 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 79eda68..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,e,i,r){var o,c,s,l,n,t,a;for(c=m(v),s=m(e),o=O(i),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c1a9a9d..3be1c93 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..38cec33 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index 7615537..38a8174 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.2", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.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-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-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-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..a8fc9a8 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 8ddfe341f74ba45a3fdd2926dc06e99eee0f9a16 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jun 2026 03:58:20 +0000 Subject: [PATCH 78/83] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 3901638..3b59be9 100644 --- a/package.json +++ b/package.json @@ -65,7 +65,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 1914c83a5a6d7248593b363e4a0275b3e6f5af77 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jun 2026 04:10:31 +0000 Subject: [PATCH 79/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 3be1c93..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 38cec33..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a8fc9a8..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 4d11d598a4063527106e7552898da1bc0108ddc6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jun 2026 04:10:52 +0000 Subject: [PATCH 80/83] 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 | 125 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 110 - benchmark/benchmark.js | 57 - benchmark/benchmark.length.js | 103 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 77 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 49 files changed, 4873 insertions(+), 5626 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 (98%) 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 15b6565..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-06-29T03:52:30.975Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index caac4ea..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 a6a8379..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,110 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 817c1a1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,57 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 d30a764..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,103 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 1554405..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,r){return function(){try{return r||v((r={exports:{}}).exports,r),r.exports}catch(s){throw (r=0, s)}};};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,r,s,a){var c,i,o,l,n,t,e;for(i=m(v),o=m(r),c=O(s),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c1a9a9d..3be1c93 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..38cec33 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index 3b59be9..38a8174 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.2", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.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-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-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-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..a8fc9a8 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From c20b0586dfdede262bc69b7e9113e01a3e7bda50 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 18 Aug 2026 03:08:26 +0000 Subject: [PATCH 81/83] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 3901638..3b59be9 100644 --- a/package.json +++ b/package.json @@ -65,7 +65,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 cf1d5b3c3893ebeac44e6410c917b7f2ecb9e02f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 18 Aug 2026 03:19:13 +0000 Subject: [PATCH 82/83] Remove files --- index.d.ts | 206 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5053 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 3be1c93..0000000 --- a/index.d.ts +++ /dev/null @@ -1,206 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection, AccessorArrayLike } from '@stdlib/types/array'; -import { Mode } from '@stdlib/types/ndarray'; - -/** -* Index array. -*/ -type IndexArray = Collection | AccessorArrayLike; - -/** -* Callback function invoked for each indexed element. -*/ -type Callback = ( value: T, index: number ) => U; - -/** -* Interface describing `takeMap`. -*/ -interface TakeMap { - /** - * Takes elements from an array based on an index array and applies a callback function to each element. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @returns output array - * - * @example - * var x = [ 1, 2, 3, 4 ]; - * - * function transform( v ) { - * return v * 2; - * } - * - * var y = takeMap( x, [ 1, 3 ], 'throw', transform ); - * // returns [ 4, 8 ] - */ - ( x: Collection, indices: IndexArray, mode: Mode, clbk: Callback ): Array; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: AccessorArrayLike, stride: number, offset: number ): AccessorArrayLike; - - /** - * Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. - * - * @param x - input array - * @param indices - list of element indices - * @param mode - index mode - * @param clbk - callback function - * @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 ] ); - * - * function transform( v ) { - * return v * 2; - * } - * - * var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); - * // returns [ 4.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] - * - * var bool = ( arr === out ); - * // returns true - */ - assign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @returns output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* function transform( v ) { -* return v * 2; -* } -* -* var y = takeMap( x, [ 1, 3 ], 'throw', transform ); -* // returns [ 4, 8 ] -*/ -declare function takeMap( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback ): Collection; - -/** -* Takes elements from an array based on an index array and applies a callback function to each element. The function assigns the transformed values to elements in a provided output array. -* -* @param x - input array -* @param indices - list of element indices -* @param mode - index mode -* @param clbk - callback function -* @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 ] ); -* -* function transform( v ) { -* return v * 2; -* } -* -* var arr = takeMap.assign( x, [ 1, 3 ], 'throw', transform, out, 2, 0 ); -* // returns [ 4.0, 0.0, 8.0, 0.0 ] -* -* var bool = ( arr === out ); -* // returns true -*/ -declare function takeMapAssign( x: Collection | AccessorArrayLike, indices: IndexArray, mode: Mode, clbk: Callback, out: Collection, stride: number, offset: number ): Collection; - - -// EXPORTS // - -export = takeMap; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 38cec33..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a8fc9a8..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 04cde0aaee791674d0bc3d80d338899cc7fc9cf3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 18 Aug 2026 03:19:39 +0000 Subject: [PATCH 83/83] 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 | 125 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.length.js | 110 - benchmark/benchmark.js | 57 - benchmark/benchmark.length.js | 103 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 89 - docs/types/test.ts | 85 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 277 - lib/index.js | 72 - lib/main.js | 82 - package.json | 77 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 707 --- test/test.js | 41 - test/test.main.js | 212 - 49 files changed, 4873 insertions(+), 5627 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 (98%) 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 769a65e..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-08-18T03:06:07.933Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index caac4ea..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-map) 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 1560508..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-map) 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 1dca573..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: '18 6 * * 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 + + ```
@@ -178,7 +175,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]. @@ -241,7 +238,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-take-map/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 a6a8379..0000000 --- a/benchmark/benchmark.assign.length.js +++ /dev/null @@ -1,110 +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 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 takeMap = 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 ]; - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap.assign( x, idx, 'throw', out, 1, 0, clbk ); - 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 817c1a1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,57 +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 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 takeMap = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::copy:len=%d', pkg, 100 ), function benchmark( b ) { - var x; - var i; - var v; - - x = zeroTo( 100 ); - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, x, 'throw', clbk ); - 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 d30a764..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,103 +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 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 takeMap = 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 ]; - - function clbk( val ) { - return val; - } - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = takeMap( x, idx, 'throw', clbk ); - 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 4bc545e..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-map" -%% click B href "https://github.com/stdlib-js/array-base-take-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-take-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-take-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-take-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-take-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-map -[production-url]: https://github.com/stdlib-js/array-base-take-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-take-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-take-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-take-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-take-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-take-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-take-map/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 4e59fb3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import takeMap from '../docs/types/index'; -export = takeMap; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 1554405..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var j=function(v,r){return function(){try{return r||v((r={exports:{}}).exports,r),r.exports}catch(s){throw (r=0, s)}};};var M=j(function(H,I){ -var m=require('@stdlib/array-base-resolve-getter/dist'),O=require('@stdlib/ndarray-base-ind/dist').factory;function R(v,r,s,a){var c,i,o,l,n,t,e;for(i=m(v),o=m(r),c=O(s),n=v.length-1,l=[],t=0;t[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = assignMap;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* var takeMap = require( '@stdlib/array-base-take-map' );\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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,QAyBhD,SAASC,EAASC,EAAGC,EAASC,EAAMC,EAAO,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOR,EAAeG,CAAE,EACxBM,EAAOT,EAAeI,CAAQ,EAG9BG,EAAWN,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBO,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIR,EAAQ,OAAQQ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,CAAE,EAAGD,CAAI,EAGtCD,EAAI,KAAMJ,EAAK,KAAM,KAAME,EAAML,EAAGU,CAAE,EAAGA,CAAE,CAAE,EAE9C,OAAOH,CACR,CAKAX,EAAO,QAAUG,ICjFjB,IAAAY,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAmB,QAAS,qCAAsC,EAClEC,EAAc,QAAS,0CAA2C,EAClEC,EAAM,QAAS,0BAA2B,EAAE,QA8BhD,SAASC,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACtE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAUJ,IAPAJ,EAAWT,EAAKI,CAAK,EAGrBM,EAAMR,EAAE,OAAS,EAGjBS,EAAKJ,EACCK,EAAI,EAAGA,EAAIT,EAAQ,OAAQS,IAChCC,EAAIJ,EAAUN,EAASS,CAAE,EAAGF,CAAI,EAChCL,EAAKM,CAAG,EAAIT,EAAGW,CAAE,EACjBF,GAAML,EAEP,IAAMM,EAAI,EAAGA,EAAIP,EAAI,OAAQO,IAE5BP,EAAIO,CAAC,EAAIJ,EAAK,KAAM,KAAMH,EAAIO,CAAC,EAAGA,CAAE,EAErC,OAAOP,CACR,CA8BA,SAASS,EAAcZ,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACpE,IAAIC,EACAM,EACAC,EACAC,EACAC,EACAC,EACAC,EACAV,EACAC,EACAC,EACAC,EAkBJ,IAhBAE,EAAQb,EAAE,KACVc,EAAQb,EAAQ,KAChBc,EAAQZ,EAAI,KAEZa,EAAOhB,EAAE,UAAW,CAAE,EACtBiB,EAAOhB,EAAQ,UAAW,CAAE,EAC5BiB,EAAOf,EAAI,UAAW,CAAE,EAGxBI,EAAWT,EAAKI,CAAK,EAGrBM,EAAMK,EAAM,OAAS,EAGrBJ,EAAKJ,EACCK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EAGpCU,EAAMH,EAAON,EAAIH,EAAK,KAAM,KAAMU,EAAMH,EAAOF,CAAE,EAAGA,CAAE,CAAE,EACxDF,GAAML,EAEP,OAAOW,CACR,CA+BA,SAASI,EAAYnB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CAClE,IAAIC,EACAO,EACAG,EACAT,EACAC,EACAW,EACAV,EACAC,EACAU,EAcJ,IAZAP,EAAQb,EAAQ,KAChBgB,EAAOhB,EAAQ,UAAW,CAAE,EAG5BM,EAAWT,EAAKI,CAAK,EAGrBM,EAAQR,EAAE,OAAO,EAAM,EAGvBoB,EAAKhB,EAAS,EACdK,EAAKJ,EAAS,EACRK,EAAI,EAAGA,EAAII,EAAM,OAAQJ,IAC9BC,EAAIJ,EAAUU,EAAMH,EAAOJ,CAAE,EAAGF,CAAI,EACpCa,EAAIV,EAAI,EAGRR,EAAKM,CAAG,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,CAAE,EAAGA,CAAE,EAGvClB,EAAKM,EAAG,CAAE,EAAIH,EAAK,KAAM,KAAMN,EAAGqB,EAAE,CAAE,EAAGA,EAAE,CAAE,EAC7CZ,GAAMW,EAEP,OAAOjB,CACR,CAgCA,SAASmB,EAAWtB,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,EAAO,CACjE,IAAIiB,EACAd,EACAe,EAKJ,OAHAD,EAAK3B,EAAkBI,CAAE,EACzBS,EAAKb,EAAkBK,CAAQ,EAC/BuB,EAAK5B,EAAkBO,CAAI,EAE1BoB,EAAG,kBACHd,EAAG,kBACHe,EAAG,iBAIF7B,EAAmB4B,EAAG,KAAM,GAC5B5B,EAAmB6B,EAAG,KAAM,GAE5BL,EAAYtB,EAAaG,EAAG,CAAE,EAAGS,EAAIP,EAAML,EAAaM,EAAK,CAAE,EAAGC,EAAQC,EAAQC,CAAK,EAChFH,IAERS,EAAcW,EAAId,EAAIP,EAAMsB,EAAIpB,EAAQC,EAAQC,CAAK,EAC9CH,IAERJ,EAAgBC,EAAGC,EAASC,EAAMC,EAAKC,EAAQC,EAAQC,CAAK,EACrDH,EACR,CAKAT,EAAO,QAAU4B,ICzNjB,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", "takeMap", "x", "indices", "mode", "clbk", "getIndex", "xget", "iget", "out", "max", "i", "j", "require_assign", "__commonJSMin", "exports", "module", "isComplexDataType", "arraylike2object", "reinterpret", "ind", "takeMapIndexed", "x", "indices", "mode", "out", "stride", "offset", "clbk", "getIndex", "max", "io", "i", "j", "accessorsMap", "xdata", "idata", "odata", "xget", "iget", "oset", "complexMap", "so", "k", "assignMap", "xo", "oo", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 50ca767..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,89 +0,0 @@ - -{{alias}}( x, indices, mode, callback ) - Takes elements from an array and returns a new array after applying a - mapping function. - - 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. - - callback : function - Map function to apply to selected elements of `x`. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, [ 1, 3 ], 'throw', {{alias:@stdlib/math/base/special/abs}} ) - [ 2, 4 ] - - -{{alias}}.assign( x, indices, mode, out, stride, offset, callback ) - Takes elements from an array, applies a mapping function, 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. - - callback : function - Map function to apply to selected elements of `x`. - - 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 ,{{alias:@stdlib/math/base/special/abs}} ) - [ 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 2eaef25..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,85 +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. -*/ - -import takeMap = require( './index' ); - -// TESTS // - -// The function returns an array... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'throw', transform ); // $ExpectType number[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'normalize', transform ); // $ExpectType any[] - takeMap( [ 1, 2, 3, 4 ], [ 1, 3 ], 'clamp', transform ); // $ExpectType number[] - takeMap( [ '1', '2', '3', '4' ], [ 1, 3 ], 'wrap', transform ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( 1, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( true, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( false, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( null, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( void 0, [ 1, 3 ], 'throw', transform ); // $ExpectError - takeMap( {}, [ 1, 3 ], 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], 1, 'throw', transform ); // $ExpectError - takeMap( [], true, 'throw', transform ); // $ExpectError - takeMap( [], false, 'throw', transform ); // $ExpectError - takeMap( [], null, 'throw', transform ); // $ExpectError - takeMap( [], void 0, 'throw', transform ); // $ExpectError - takeMap( [], {}, 'throw', transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid index mode... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap( [], [ 1, 3 ], '1', transform ); // $ExpectError - takeMap( [], [ 1, 3 ], 1, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], true, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], false, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], null, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], void 0, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], {}, transform ); // $ExpectError - takeMap( [], [ 1, 3 ], [], transform ); // $ExpectError - takeMap( [], [ 1, 3 ], ( x: number ): number => x, transform ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - // eslint-disable-next-line @typescript-eslint/explicit-function-return-type - const transform = ( v: number ) => v * 2; - - takeMap(); // $ExpectError - takeMap( [], [] ); // $ExpectError - takeMap( [], [], 'throw' ); // $ExpectError - takeMap( [], [], 'throw', transform, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 3986b7b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +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'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var takeMap = 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 ); - -// Define a mapping function (e.g., square the value): -function square( val ) { - return val * val; -} - -// Take a random sample of elements from `x` and apply the mapping function: -var y = takeMap( x, indices, 'throw', square ); -console.log( y ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c1a9a9d..3be1c93 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike } from '@stdlib/types/array'; import { Mode } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..38cec33 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.3-esm/index.mjs";import{factory as t}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-arraylike2object@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex@v0.1.3-esm/index.mjs";function a(e,r,n,l){var a,o,i,d,c,m,p;for(o=s(e),i=s(r),a=t(n),c=e.length-1,d=[],m=0;m[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]\n*/\nfunction complexMap( x, indices, mode, out, stride, offset, clbk ) {\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\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io ] = clbk.call( null, x[ k ], k );\n\n\t\t// eslint-disable-next-line no-useless-call\n\t\tout[ io+1 ] = clbk.call( null, x[ k+1 ], 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* @param {Function} clbk - callback function applied to each selected element.\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*\n* function clbk( val ){\n\treturn val;\n}\n* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk );\n* // arr is [ 4, 2, 3, 1 ]\n*\n* var bool = ( arr === out );\n* // bool is true\n*/\nfunction assignMap( x, indices, mode, out, stride, offset, clbk ) {\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\tcomplexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len\n\t\t\treturn out;\n\t\t}\n\t\taccessorsMap( xo, io, mode, oo, stride, offset, clbk );\n\t\treturn out;\n\t}\n\ttakeMapIndexed( x, indices, mode, out, stride, offset, clbk );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default assignMap;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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 and apply a provided function to map values.\n*\n* @module @stdlib/array-base-take-map\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* function mapFunction( val ) {\n* return val;\n* }\n*\n* var indices = [ 0, 0, 1, 1, 3, 3 ];\n* var y = takeMap( x, indices, 'throw', mapFunction );\n* // returns [ 1, 1, 2, 2, 4, 4 ]\n*\n* @example\n* import takeMap from '@stdlib/array-base-take-map';\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* function clbk( val ) {\n* return val;\n* }\n*\n* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction );\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":["takeMap","x","indices","mode","clbk","getIndex","xget","iget","out","max","i","j","resolveGetter","ind","length","push","call","assignMap","stride","offset","xo","io","oo","arraylike2object","accessorProtocol","isComplexDataType","dtype","idata","so","k","data","accessors","complexMap","reinterpret","xdata","odata","oset","accessorsMap","takeMapIndexed","setReadOnly","main","assign"],"mappings":";;mpBAgDA,SAASA,EAASC,EAAGC,EAASC,EAAMC,GACnC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAcJ,IAXAL,EAAOM,EAAeX,GACtBM,EAAOK,EAAeV,GAGtBG,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBN,EAAM,GACAE,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUE,EAAML,EAASQ,GAAKD,GAGlCD,EAAIO,KAAMX,EAAKY,KAAM,KAAMV,EAAML,EAAGU,GAAKA,IAE1C,OAAOH,CACR,CCyKA,SAASS,EAAWhB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC1D,IAAIgB,EACAC,EACAC,EAKJ,OAHAF,EAAKG,EAAkBtB,GACvBoB,EAAKE,EAAkBrB,GACvBoB,EAAKC,EAAkBf,GAEtBY,EAAGI,kBACHH,EAAGG,kBACHF,EAAGE,iBAIFC,EAAmBL,EAAGM,QACtBD,EAAmBH,EAAGI,QAnFzB,SAAqBzB,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC3D,IAAIC,EACAsB,EACApB,EACAE,EACAY,EACAO,EACAlB,EAEAmB,EAcJ,IAZAF,EAAQzB,EAAQ4B,KAChBvB,EAAOL,EAAQ6B,UAAW,GAG1B1B,EAAWQ,EAAKV,GAGhBM,EAAQR,EAAEa,OAAO,EAAM,EAGvBc,EAAc,EAATV,EACLG,EAAc,EAATF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAE9BmB,EAAQ,EADJxB,EAAUE,EAAMoB,EAAOjB,GAAKD,GAIhCD,EAAKa,GAAOjB,EAAKY,KAAM,KAAMf,EAAG4B,GAAKA,GAGrCrB,EAAKa,EAAG,GAAMjB,EAAKY,KAAM,KAAMf,EAAG4B,EAAE,GAAKA,EAAE,GAC3CR,GAAMO,CAGR,CAkDGI,CAAYC,EAAahC,EAAG,GAAKoB,EAAIlB,EAAM8B,EAAazB,EAAK,GAAKU,EAAQC,EAAQf,GAC3EI,IA1JV,SAAuBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC7D,IAAIC,EACA6B,EACAP,EACAQ,EACA7B,EACAC,EACA6B,EACA3B,EACAY,EACAX,EACAC,EAkBJ,IAhBAuB,EAAQjC,EAAE6B,KACVH,EAAQzB,EAAQ4B,KAChBK,EAAQ3B,EAAIsB,KAEZxB,EAAOL,EAAE8B,UAAW,GACpBxB,EAAOL,EAAQ6B,UAAW,GAC1BK,EAAO5B,EAAIuB,UAAW,GAGtB1B,EAAWQ,EAAKV,GAGhBM,EAAMyB,EAAMpB,OAAS,EAGrBO,EAAKF,EACCT,EAAI,EAAGA,EAAIiB,EAAMb,OAAQJ,IAC9BC,EAAIN,EAAUE,EAAMoB,EAAOjB,GAAKD,GAGhC2B,EAAMD,EAAOd,EAAIjB,EAAKY,KAAM,KAAMV,EAAM4B,EAAOvB,GAAKA,IACpDU,GAAMH,CAGR,CAuHEmB,CAAcjB,EAAIC,EAAIlB,EAAMmB,EAAIJ,EAAQC,EAAQf,GACzCI,IApNT,SAAyBP,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAC/D,IAAIC,EACAI,EACAY,EACAX,EACAC,EAUJ,IAPAN,EAAWQ,EAAKV,GAGhBM,EAAMR,EAAEa,OAAS,EAGjBO,EAAKF,EACCT,EAAI,EAAGA,EAAIR,EAAQY,OAAQJ,IAChCC,EAAIN,EAAUH,EAASQ,GAAKD,GAC5BD,EAAKa,GAAOpB,EAAGU,GACfU,GAAMH,EAEP,IAAMR,EAAI,EAAGA,EAAIF,EAAIM,OAAQJ,IAE5BF,EAAIE,GAAKN,EAAKY,KAAM,KAAMR,EAAIE,GAAIA,EAGpC,CA6LC4B,CAAgBrC,EAAGC,EAASC,EAAMK,EAAKU,EAAQC,EAAQf,GAChDI,EACR,CC7MA+B,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 7871ae6..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,277 +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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ -* return val; -* } -* -* var arr = takeMapIndexed( x, indices, 'throw', out, 1, 0, clbk ); -* // returns [ 4, 2, 3, 1 ] -*/ -function takeMapIndexed( x, indices, mode, out, stride, offset, clbk ) { - 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; - } - for ( i = 0; i < out.length; i++ ) { - // eslint-disable-next-line no-useless-call - out[i] = clbk.call( null, out[i], i ); - } - 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. -* @param {Function} clbk - callback function applied to each selected element. -* @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 ] ); -* -* function clbk(val){ - return val+1; -} -* -* var out = toAccessorArray( [ 0, 0, 0, 0 ] ); -* var arr = accessorsMap( arraylike2object( x ), arraylike2object( indices ), 'throw', arraylike2object( out ), 1, 0, clbk ); -* // [ 4, 2, 3, 1 ] -*/ -function accessorsMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - oset( odata, io, clbk.call( null, xget( xdata, j ), 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 -* @param {Function} clbk - callback function applied to each selected element -* @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 ); -* -* function clbk(val){ - return val; -} -* -* var arr = complexMap( x, arraylike2object( indices ), 'throw', out, 1, 0, clbk ); -* // returns [ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ] -*/ -function complexMap( x, indices, mode, out, stride, offset, clbk ) { - 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; - - // eslint-disable-next-line no-useless-call - out[ io ] = clbk.call( null, x[ k ], k ); - - // eslint-disable-next-line no-useless-call - out[ io+1 ] = clbk.call( null, x[ k+1 ], 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. -* @param {Function} clbk - callback function applied to each selected element. -* @returns {Collection} output array. -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* var out = [ 0, 0, 0, 0 ]; -* -* function clbk( val ){ - return val; -} -* var arr = assignMap( x, indices, 'throw', out, 1, 0, clbk ); -* // arr is [ 4, 2, 3, 1 ] -* -* var bool = ( arr === out ); -* // bool is true -*/ -function assignMap( x, indices, mode, out, stride, offset, clbk ) { - 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 ) - ) { - complexMap( reinterpret( x, 0 ), io, mode, reinterpret( out, 0 ), stride, offset, clbk ); // eslint-disable-line max-len - return out; - } - accessorsMap( xo, io, mode, oo, stride, offset, clbk ); - return out; - } - takeMapIndexed( x, indices, mode, out, stride, offset, clbk ); - return out; -} - - -// EXPORTS // - -module.exports = assignMap; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f30fa24..0000000 --- a/lib/index.js +++ /dev/null @@ -1,72 +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'; - -/** -* Take elements from an array and apply a provided function to map values. -* -* @module @stdlib/array-base-take-map -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* function mapFunction( val ) { -* return val; -* } -* -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* var y = takeMap( x, indices, 'throw', mapFunction ); -* // returns [ 1, 1, 2, 2, 4, 4 ] -* -* @example -* var takeMap = require( '@stdlib/array-base-take-map' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0, 0, 0, 0 ]; -* var indices = [ 0, 0, 1, 1, 3, 3 ]; -* -* function clbk( val ) { -* return val; -* } -* -* var arr = takeMap.assign( x, indices, 'throw', out, 1, 0, mapFunction ); -* // 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 56548a3..0000000 --- a/lib/main.js +++ /dev/null @@ -1,82 +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 resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var ind = require( '@stdlib/ndarray-base-ind' ).factory; - - -// MAIN // - -/** -* Takes elements from an array, applies a mapping function using a callback, and returns a new array. -* -* @param {Collection} x - input array -* @param {IntegerArray} indices - list of indices -* @param {string} mode - index mode -* @param {Function} clbk - callback to invoke -* @returns {Array} output array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* var indices = [ 3, 1, 2, 0 ]; -* -* function clbk(val){ - return 2 * val; -} -* -* var y = takeMap( x, indices, 'throw' ,clbk ); -* // returns [ 8, 4, 6, 2 ] -*/ -function takeMap( x, indices, mode, clbk ) { - 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 ); - - // eslint-disable-next-line no-useless-call - out.push( clbk.call( null, xget( x, j ), j ) ); // use `Array#push` to ensure "fast" elements - } - return out; -} - - -// EXPORTS // - -module.exports = takeMap; diff --git a/package.json b/package.json index 3b59be9..38a8174 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.2", "description": "Take elements from an array and return a new array after applying a mapping function.", "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.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-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-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-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..a8fc9a8 --- /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 02ed25a..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,707 +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 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 takeMap = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, '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; - - function clbk( val ) { - return val * val; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'generic' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 4, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 4, 0, 4, 0, 16, 0, 16, 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 1, 4, 9, 16 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function takes and maps elements from an array (real typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val * 2; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - indices = [ 1, 3 ]; - out = zeros( indices.length, 'float64' ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = new Float64Array( [ 4.0, 8.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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 8.0, 0.0, 8.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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = new Float64Array( [ 0.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.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 and maps elements from an array (complex typed array)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - 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 = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - 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 and maps elements from an array (accessors)', function test( t ) { - var expected; - var indices; - var actual; - var out; - var x; - - function clbk( val ) { - return val + 1; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - - indices = toAccessorArray( [ 1, 3 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 1, 0, clbk ); - expected = [ 3, 5 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 1, 1, 3, 3 ] ); - out = toAccessorArray( zeros( indices.length*2, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, 2, 0, clbk ); - expected = [ 3, 0, 3, 0, 5, 0, 5, 0 ]; - - t.strictEqual( actual, out, 'returns expected value' ); - isEqual( actual, expected ); - - indices = toAccessorArray( [ 3, 2, 1, 0 ] ); - out = toAccessorArray( zeros( indices.length, 'generic' ) ); - actual = takeMap( x, indices, 'throw', out, -1, out.length-1, clbk ); - expected = [ 2, 3, 4, 5 ]; - - 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 = takeMap( x, indices, 'throw', out, 1, 1, clbk ); - expected = [ 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3 ]; - - 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 an output array unchanged if provided a second argument which is empty', function test( t ) { - var expected; - var actual; - var out; - var x; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - out = [ 0, 0, 0, 0 ]; - expected = [ 0, 0, 0, 0 ]; - actual = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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 = takeMap( x, [], 'throw', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'throw', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val * 2; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -1, -2, -3, -4 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'normalize', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2, -3, -4 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -1, -2 ]; - out = zeros( x.length, 'complex128' ); - - actual = takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - 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() { - takeMap( x, indices, 'normalize', out, 1, 0, clbk ); - } -}); - -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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'clamp', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'clamp', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'generic' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = toAccessorArray( [ 1, 2, 3, 4 ] ); - indices = toAccessorArray( [ -10, 10, -5, 5 ] ); - out = zeros( x.length, 'generic' ); - - takeMap( x, indices, 'wrap', toAccessorArray( out ), 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - indices = [ -10, 10, -5, 5 ]; - out = zeros( x.length, 'float64' ); - - actual = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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; - - function clbk( val ) { - return val; - } - - 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 = takeMap( x, indices, 'wrap', out, 1, 0, clbk ); - 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 ecb5eea..0000000 --- a/test/test.js +++ /dev/null @@ -1,41 +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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var hasMethod = require( '@stdlib/assert-is-method' ); -var takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( takeMap, 'assign' ), true, 'returns expected value' ); - t.strictEqual( hasMethod( takeMap, 'assign' ), true, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 2ab8b79..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +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 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 takeMap = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof takeMap, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof takeMap.assign, 'function', 'assign method is a function' ); - t.end(); -}); - -tape( 'the function takes elements from an array', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ 1, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 3, 3 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 16, 16 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 3, 2, 1, 0 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 16, 9, 4, 1 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - indices = [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ]; - actual = takeMap( x, indices, 'throw', clbk ); - expected = [ 4, 4, 4, 4, 4, 4, 4, 4, 4, 4 ]; - 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; - - function clbk( v ) { - return v; - } - - 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 = takeMap( x, indices, 'throw', clbk ); - - 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 ]; - function clbk( v ) { - return v; - } - t.deepEqual( takeMap( x, [], 'throw' ), [], 'returns expected value', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 4, 5, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'throw', clbk ); - } -}); - -tape( 'when the "mode" is "normalize", the function normalizes negative indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v*2; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -1, -2, -3, -4 ]; - actual = takeMap( x, indices, 'normalize', clbk ); - expected = [ 8, 6, 4, 2 ]; - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - indices = [ 2, 50, 1, 2 ]; - - t.throws( badValue, RangeError, 'throws an error' ); - t.end(); - - function badValue() { - takeMap( x, indices, 'normalize', clbk ); - } -}); - -tape( 'when the "mode" is "clamp", the function clamps out-of-bounds indices', function test( t ) { - var expected; - var indices; - var actual; - var x; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'clamp', clbk ); - 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; - - function clbk( v ) { - return v; - } - - x = [ 1, 2, 3, 4 ]; - - indices = [ -10, 10, -5, 5 ]; - actual = takeMap( x, indices, 'wrap', clbk ); - expected = [ 3, 3, 4, 2 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -});