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 7827464..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-08-19T03:11:41.379Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index f2f7d7b..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/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 0b389fb..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/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 52ddcc8..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: '7 19 * * 5' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 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 + + ```
@@ -222,7 +219,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]. @@ -285,7 +282,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-map/main/LICENSE -[@stdlib/array/base/accessor]: https://github.com/stdlib-js/array-base-accessor +[@stdlib/array/base/accessor]: https://github.com/stdlib-js/array-base-accessor/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.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 9fc9dbb..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,107 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var uniform = require( '@stdlib/random-array-uniform' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var map = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x; - var y; - - x = uniform( len, -100.0, 100.0, { - 'dtype': 'generic' - }); - y = zeros( len ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map( x, y, 1, 0, identity ); - if ( isnan( out[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - if ( isnan( out[ i % len ] ) ) { - b.fail( 'should not return NaN' ); - } - 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:dtype=generic,len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 3e0fa12..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var uniform = require( '@stdlib/random-array-uniform' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var map = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = uniform( len, -100.0, 100.0, { - 'dtype': 'generic' - }); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map( x, identity ); - if ( isnan( out[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - if ( isnan( out[ i % len ] ) ) { - b.fail( 'should not return NaN' ); - } - 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:dtype=generic,len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index e7de1f2..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/map" -%% click B href "https://github.com/stdlib-js/array-base-map/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map -[production-url]: https://github.com/stdlib-js/array-base-map/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-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 4504e2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map from '../docs/types/index'; -export = map; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index dde4852..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(a,r){return function(){try{return r||a((r={exports:{}}).exports,r),r.exports}catch(s){throw (r=0, s)}};};var v=p(function(B,q){ -var g=require('@stdlib/array-base-arraylike2object/dist');function h(a,r,s,o,n,i){var e,t;for(e=o,t=0;t [ 10.0, 10.0, 10.0, 10.0 ]\n*/\nfunction accessors( x, y, stride, offset, fcn, thisArg ) {\n\tvar xdata;\n\tvar ydata;\n\tvar xget;\n\tvar yset;\n\tvar io;\n\tvar i;\n\n\txdata = x.data;\n\tydata = y.data;\n\txget = x.accessors[ 0 ];\n\tyset = y.accessors[ 1 ];\n\n\tio = offset;\n\tfor ( i = 0; i < xdata.length; i++ ) {\n\t\tyset( ydata, io, fcn.call( thisArg, xget( xdata, i ), i, xdata ) );\n\t\tio += stride;\n\t}\n\treturn y;\n}\n\n\n// MAIN //\n\n/**\n* Applies a callback function to elements in an input array and assigns results to elements in an output array.\n*\n* @param {Collection} x - input array\n* @param {Collection} y - output array\n* @param {integer} stride - stride length for output array\n* @param {NonNegativeInteger} offset - starting index for output array\n* @param {Function} fcn - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var ones = require( '@stdlib/array-base-ones' );\n* var zeros = require( '@stdlib/array-base-zeros' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var x = ones( 4 );\n* var y = zeros( x.length );\n*\n* var out = assign( x, y, 1, 0, scale );\n* // returns [ 10.0, 10.0, 10.0, 10.0 ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction assign( x, y, stride, offset, fcn, thisArg ) {\n\tvar xobj;\n\tvar yobj;\n\n\txobj = arraylike2object( x );\n\tyobj = arraylike2object( y );\n\tif ( xobj.accessorProtocol || yobj.accessorProtocol ) {\n\t\taccessors( xobj, yobj, stride, offset, fcn, thisArg );\n\t\treturn y;\n\t}\n\treturn internal( x, y, stride, offset, fcn, thisArg );\n}\n\n\n// EXPORTS //\n\nmodule.exports = assign;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether an object has a specified method.\n*\n* @private\n* @param {Object} obj - input object\n* @param {string} method - method name\n* @returns {boolean} boolean indicating whether an object has a specified method\n*\n* @example\n* var bool = hasMethod( [], 'map' );\n* // returns true\n*\n* @example\n* var bool = hasMethod( [], 'beep' );\n* // returns false\n*/\nfunction hasMethod( obj, method ) {\n\treturn ( typeof obj[ method ] === 'function' );\n}\n\n\n// MAIN //\n\n/**\n* Applies a callback function to elements in an input array and assigns results to elements in a new output array.\n*\n* @param {Collection} x - input array\n* @param {Function} fcn - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var ones = require( '@stdlib/array-base-ones' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var x = ones( 4 );\n* var y = map( x, scale );\n* // returns [ 10.0, 10.0, 10.0, 10.0 ]\n*/\nfunction map( x, fcn, thisArg ) {\n\tif ( hasMethod( x, 'map' ) ) {\n\t\treturn x.map( fcn, thisArg );\n\t}\n\treturn assign( x, zeros( x.length ), 1, 0, fcn, thisArg );\n}\n\n\n// EXPORTS //\n\nmodule.exports = map;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a callback function to elements in an input array and assign results to elements in a new output array.\n*\n* @module @stdlib/array-base-map\n*\n* @example\n* var ones = require( '@stdlib/array-base-ones' );\n* var map = require( '@stdlib/array-base-map' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var x = ones( 4 );\n* var y = map( x, scale );\n* // returns [ 10.0, 10.0, 10.0, 10.0 ]\n*\n* @example\n* var ones = require( '@stdlib/array-base-ones' );\n* var zeros = require( '@stdlib/array-base-zeros' );\n* var map = require( '@stdlib/array-base-map' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var x = ones( 4 );\n* var y = zeros( x.length );\n*\n* var out = map.assign( x, y, 1, 0, scale );\n* // returns [ 10.0, 10.0, 10.0, 10.0 ]\n*\n* var bool = ( out === y );\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\n// exports: { \"assign\": \"main.assign\" }\n"], - "mappings": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,qCAAsC,EAiCtE,SAASC,EAAUC,EAAGC,EAAGC,EAAQC,EAAQC,EAAKC,EAAU,CACvD,IAAIC,EACAC,EAGJ,IADAD,EAAKH,EACCI,EAAI,EAAGA,EAAIP,EAAE,OAAQO,IAC1BN,EAAGK,CAAG,EAAIF,EAAI,KAAMC,EAASL,EAAGO,CAAE,EAAGA,EAAGP,CAAE,EAC1CM,GAAMJ,EAEP,OAAOD,CACR,CA8BA,SAASO,EAAWR,EAAGC,EAAGC,EAAQC,EAAQC,EAAKC,EAAU,CACxD,IAAII,EACAC,EACAC,EACAC,EACAN,EACAC,EAQJ,IANAE,EAAQT,EAAE,KACVU,EAAQT,EAAE,KACVU,EAAOX,EAAE,UAAW,CAAE,EACtBY,EAAOX,EAAE,UAAW,CAAE,EAEtBK,EAAKH,EACCI,EAAI,EAAGA,EAAIE,EAAM,OAAQF,IAC9BK,EAAMF,EAAOJ,EAAIF,EAAI,KAAMC,EAASM,EAAMF,EAAOF,CAAE,EAAGA,EAAGE,CAAM,CAAE,EACjEH,GAAMJ,EAEP,OAAOD,CACR,CAiCA,SAASY,EAAQb,EAAGC,EAAGC,EAAQC,EAAQC,EAAKC,EAAU,CACrD,IAAIS,EACAC,EAIJ,OAFAD,EAAOhB,EAAkBE,CAAE,EAC3Be,EAAOjB,EAAkBG,CAAE,EACtBa,EAAK,kBAAoBC,EAAK,kBAClCP,EAAWM,EAAMC,EAAMb,EAAQC,EAAQC,EAAKC,CAAQ,EAC7CJ,GAEDF,EAAUC,EAAGC,EAAGC,EAAQC,EAAQC,EAAKC,CAAQ,CACrD,CAKAR,EAAO,QAAUgB,ICnKjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IAqBb,SAASC,EAAWC,EAAKC,EAAS,CACjC,OAAS,OAAOD,EAAKC,CAAO,GAAM,UACnC,CAwBA,SAASC,EAAKC,EAAGC,EAAKC,EAAU,CAC/B,OAAKN,EAAWI,EAAG,KAAM,EACjBA,EAAE,IAAKC,EAAKC,CAAQ,EAErBP,EAAQK,EAAGN,EAAOM,EAAE,MAAO,EAAG,EAAG,EAAGC,EAAKC,CAAQ,CACzD,CAKAT,EAAO,QAAUM,ICtBjB,IAAII,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "arraylike2object", "internal", "x", "y", "stride", "offset", "fcn", "thisArg", "io", "i", "accessors", "xdata", "ydata", "xget", "yset", "assign", "xobj", "yobj", "require_main", "__commonJSMin", "exports", "module", "zeros", "assign", "hasMethod", "obj", "method", "map", "x", "fcn", "thisArg", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 980ebde..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, fcn[, thisArg] ) - Applies a callback function to elements in an input array and assigns - results to elements in a new output array. - - The callback function is provided the following arguments: - - - value: current array element. - - index: current array element index. - - arr: the input array. - - If provided an array-like object having a `map` method, the function defers - execution to that method and assumes that the method has the following - signature: - - x.map( fcn, thisArg ) - - Parameters - ---------- - x: Array|TypedArray|Object - Input array. - - fcn: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = {{alias}}( x, {{alias:@stdlib/math/base/special/abs}} ) - [ 1, 2, 3, 4 ] - - -{{alias}}.assign( x, y, stride, offset, fcn[, thisArg] ) - Applies a callback function to elements in an input array and assigns - results to elements in an output array. - - Parameters - ---------- - x: Array|TypedArray|Object - Input array. - - y: Array|TypedArray|Object - Output array. - - stride: integer - Stride length for output array. - - offset: integer - Starting index for output array. - - fcn: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var x = [ -1, -2, -3, -4 ]; - > var y = [ 0, 0, 0, 0 ]; - > var out = {{alias}}.assign( x, y, 1, 0, {{alias:@stdlib/math/base/special/abs}} ) - [ 1, 2, 3, 4 ] - > var bool = ( out === y ) - true - - See Also - -------- diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index d668aca..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,263 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -import map = require( './index' ); - -/** -* Callback function. -* -* @param v - input value -* @returns output value -*/ -function fcn( v: number ): number { - return v * 2; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ 1, 2, 3 ]; - - map( x, fcn ); // $ExpectType number[] - map( new Float64Array( x ), fcn ); // $ExpectType Float64Array - map( new Float32Array( x ), fcn ); // $ExpectType Float32Array - map( new Int32Array( x ), fcn ); // $ExpectType Int32Array - map( new Int16Array( x ), fcn ); // $ExpectType Int16Array - map( new Int8Array( x ), fcn ); // $ExpectType Int8Array - map( new Uint32Array( x ), fcn ); // $ExpectType Uint32Array - map( new Uint16Array( x ), fcn ); // $ExpectType Uint16Array - map( new Uint8Array( x ), fcn ); // $ExpectType Uint8Array - map( new Uint8ClampedArray( x ), fcn ); // $ExpectType Uint8ClampedArray - map( toAccessorArray( x ), fcn ); // $ExpectType number[] - - map( x, fcn, {} ); // $ExpectType number[] - map( new Float64Array( x ), fcn, {} ); // $ExpectType Float64Array - map( new Float32Array( x ), fcn, {} ); // $ExpectType Float32Array - map( new Int32Array( x ), fcn, {} ); // $ExpectType Int32Array - map( new Int16Array( x ), fcn, {} ); // $ExpectType Int16Array - map( new Int8Array( x ), fcn, {} ); // $ExpectType Int8Array - map( new Uint32Array( x ), fcn, {} ); // $ExpectType Uint32Array - map( new Uint16Array( x ), fcn, {} ); // $ExpectType Uint16Array - map( new Uint8Array( x ), fcn, {} ); // $ExpectType Uint8Array - map( new Uint8ClampedArray( x ), fcn, {} ); // $ExpectType Uint8ClampedArray - map( toAccessorArray( x ), fcn, {} ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not a collection... -{ - map( 'abc', fcn ); // $ExpectError - map( 3.14, fcn ); // $ExpectError - map( true, fcn ); // $ExpectError - map( false, fcn ); // $ExpectError - map( null, fcn ); // $ExpectError - map( {}, fcn ); // $ExpectError - map( ( x: number ): number => x, fcn ); // $ExpectError - - map( 'abc', fcn, {} ); // $ExpectError - map( 3.14, fcn, {} ); // $ExpectError - map( true, fcn, {} ); // $ExpectError - map( false, fcn, {} ); // $ExpectError - map( null, fcn, {} ); // $ExpectError - map( {}, fcn, {} ); // $ExpectError - map( ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a function... -{ - map( [ 1, 2, 3 ], 'abc' ); // $ExpectError - map( [ 1, 2, 3 ], 2 ); // $ExpectError - map( [ 1, 2, 3 ], false ); // $ExpectError - map( [ 1, 2, 3 ], true ); // $ExpectError - map( [ 1, 2, 3 ], null ); // $ExpectError - map( [ 1, 2, 3 ], void 0 ); // $ExpectError - map( [ 1, 2, 3 ], {} ); // $ExpectError - map( [ 1, 2, 3 ], [] ); // $ExpectError - - map( [ 1, 2, 3 ], 'abc', {} ); // $ExpectError - map( [ 1, 2, 3 ], 2, {} ); // $ExpectError - map( [ 1, 2, 3 ], false, {} ); // $ExpectError - map( [ 1, 2, 3 ], true, {} ); // $ExpectError - map( [ 1, 2, 3 ], null, {} ); // $ExpectError - map( [ 1, 2, 3 ], void 0, {} ); // $ExpectError - map( [ 1, 2, 3 ], {}, {} ); // $ExpectError - map( [ 1, 2, 3 ], [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - map(); // $ExpectError - map( [ 1, 2, 3 ] ); // $ExpectError - map( [ 1, 2, 3 ], fcn, {}, 3 ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ 1, 2, 3 ]; - const y = [ 0, 0, 0 ]; - - map.assign( x, y, 1, 0, fcn ); // $ExpectType number[] - map.assign( new Float64Array( x ), new Float64Array( y ), 1, 0, fcn ); // $ExpectType Float64Array - map.assign( new Float32Array( x ), new Float32Array( y ), 1, 0, fcn ); // $ExpectType Float32Array - map.assign( new Int32Array( x ), new Int32Array( y ), 1, 0, fcn ); // $ExpectType Int32Array - map.assign( new Int16Array( x ), new Int16Array( y ), 1, 0, fcn ); // $ExpectType Int16Array - map.assign( new Int8Array( x ), new Int8Array( y ), 1, 0, fcn ); // $ExpectType Int8Array - map.assign( new Uint32Array( x ), new Uint32Array( y ), 1, 0, fcn ); // $ExpectType Uint32Array - map.assign( new Uint16Array( x ), new Uint16Array( y ), 1, 0, fcn ); // $ExpectType Uint16Array - map.assign( new Uint8Array( x ), new Uint8Array( y ), 1, 0, fcn ); // $ExpectType Uint8Array - map.assign( new Uint8ClampedArray( x ), new Uint8ClampedArray( y ), 1, 0, fcn ); // $ExpectType Uint8ClampedArray - map.assign( toAccessorArray( x ), y, 1, 0, fcn ); // $ExpectType number[] - map.assign( toAccessorArray( x ), toAccessorArray( y ), 1, 0, fcn ); // $ExpectType AccessorArrayLike - - map.assign( x, y, 1, 0, fcn, {} ); // $ExpectType number[] - map.assign( new Float64Array( x ), new Float64Array( y ), 1, 0, fcn, {} ); // $ExpectType Float64Array - map.assign( new Float32Array( x ), new Float32Array( y ), 1, 0, fcn, {} ); // $ExpectType Float32Array - map.assign( new Int32Array( x ), new Int32Array( y ), 1, 0, fcn, {} ); // $ExpectType Int32Array - map.assign( new Int16Array( x ), new Int16Array( y ), 1, 0, fcn, {} ); // $ExpectType Int16Array - map.assign( new Int8Array( x ), new Int8Array( y ), 1, 0, fcn, {} ); // $ExpectType Int8Array - map.assign( new Uint32Array( x ), new Uint32Array( y ), 1, 0, fcn, {} ); // $ExpectType Uint32Array - map.assign( new Uint16Array( x ), new Uint16Array( y ), 1, 0, fcn, {} ); // $ExpectType Uint16Array - map.assign( new Uint8Array( x ), new Uint8Array( y ), 1, 0, fcn, {} ); // $ExpectType Uint8Array - map.assign( new Uint8ClampedArray( x ), new Uint8ClampedArray( y ), 1, 0, fcn, {} ); // $ExpectType Uint8ClampedArray - map.assign( toAccessorArray( x ), y, 1, 0, fcn, {} ); // $ExpectType number[] - map.assign( toAccessorArray( x ), toAccessorArray( y ), 1, 0, fcn, {} ); // $ExpectType AccessorArrayLike -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a collection... -{ - const y = [ 0, 0, 0 ]; - - map.assign( 2, y, 1, 0, fcn ); // $ExpectError - map.assign( false, y, 1, 0, fcn ); // $ExpectError - map.assign( true, y, 1, 0, fcn ); // $ExpectError - map.assign( null, y, 1, 0, fcn ); // $ExpectError - map.assign( void 0, y, 1, 0, fcn ); // $ExpectError - map.assign( {}, y, 1, 0, fcn ); // $ExpectError - - map.assign( 2, y, 1, 0, fcn, {} ); // $ExpectError - map.assign( false, y, 1, 0, fcn, {} ); // $ExpectError - map.assign( true, y, 1, 0, fcn, {} ); // $ExpectError - map.assign( null, y, 1, 0, fcn, {} ); // $ExpectError - map.assign( void 0, y, 1, 0, fcn, {} ); // $ExpectError - map.assign( {}, y, 1, 0, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a collection... -{ - const x = [ 1, 2, 3 ]; - - map.assign( x, 2, 1, 0, fcn ); // $ExpectError - map.assign( x, false, 1, 0, fcn ); // $ExpectError - map.assign( x, true, 1, 0, fcn ); // $ExpectError - map.assign( x, null, 1, 0, fcn ); // $ExpectError - map.assign( x, void 0, 1, 0, fcn ); // $ExpectError - map.assign( x, {}, 1, 0, fcn ); // $ExpectError - - map.assign( x, 2, 1, 0, fcn, {} ); // $ExpectError - map.assign( x, false, 1, 0, fcn, {} ); // $ExpectError - map.assign( x, true, 1, 0, fcn, {} ); // $ExpectError - map.assign( x, null, 1, 0, fcn, {} ); // $ExpectError - map.assign( x, void 0, 1, 0, fcn, {} ); // $ExpectError - map.assign( x, {}, 1, 0, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a number... -{ - const x = [ 1, 2, 3 ]; - const y = [ 0, 0, 0 ]; - - map.assign( x, y, '5', 0, fcn ); // $ExpectError - map.assign( x, y, false, 0, fcn ); // $ExpectError - map.assign( x, y, true, 0, fcn ); // $ExpectError - map.assign( x, y, null, 0, fcn ); // $ExpectError - map.assign( x, y, void 0, 0, fcn ); // $ExpectError - map.assign( x, y, {}, 0, fcn ); // $ExpectError - map.assign( x, y, [], 0, fcn ); // $ExpectError - map.assign( x, y, ( x: number ): number => x, 0, fcn ); // $ExpectError - - map.assign( x, y, '5', 0, fcn, {} ); // $ExpectError - map.assign( x, y, false, 0, fcn, {} ); // $ExpectError - map.assign( x, y, true, 0, fcn, {} ); // $ExpectError - map.assign( x, y, null, 0, fcn, {} ); // $ExpectError - map.assign( x, y, void 0, 0, fcn, {} ); // $ExpectError - map.assign( x, y, {}, 0, fcn, {} ); // $ExpectError - map.assign( x, y, [], 0, fcn, {} ); // $ExpectError - map.assign( x, y, ( x: number ): number => x, 0, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a number... -{ - const x = [ 1, 2, 3 ]; - const y = [ 0, 0, 0 ]; - - map.assign( x, y, 1, '5', fcn ); // $ExpectError - map.assign( x, y, 1, false, fcn ); // $ExpectError - map.assign( x, y, 1, true, fcn ); // $ExpectError - map.assign( x, y, 1, null, fcn ); // $ExpectError - map.assign( x, y, 1, void 0, fcn ); // $ExpectError - map.assign( x, y, 1, {}, fcn ); // $ExpectError - map.assign( x, y, 1, [], fcn ); // $ExpectError - map.assign( x, y, 1, ( x: number ): number => x, fcn ); // $ExpectError - - map.assign( x, y, 1, '5', fcn, {} ); // $ExpectError - map.assign( x, y, 1, false, fcn, {} ); // $ExpectError - map.assign( x, y, 1, true, fcn, {} ); // $ExpectError - map.assign( x, y, 1, null, fcn, {} ); // $ExpectError - map.assign( x, y, 1, void 0, fcn, {} ); // $ExpectError - map.assign( x, y, 1, {}, fcn, {} ); // $ExpectError - map.assign( x, y, 1, [], fcn, {} ); // $ExpectError - map.assign( x, y, 1, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a function... -{ - const x = [ 1, 2, 3 ]; - const y = [ 0, 0, 0 ]; - - map.assign( x, y, 1, 0, '5' ); // $ExpectError - map.assign( x, y, 1, 0, 5 ); // $ExpectError - map.assign( x, y, 1, 0, false ); // $ExpectError - map.assign( x, y, 1, 0, true ); // $ExpectError - map.assign( x, y, 1, 0, null ); // $ExpectError - map.assign( x, y, 1, 0, void 0 ); // $ExpectError - map.assign( x, y, 1, 0, {} ); // $ExpectError - map.assign( x, y, 1, 0, [] ); // $ExpectError - - map.assign( x, y, 1, 0, '5', {} ); // $ExpectError - map.assign( x, y, 1, 0, 5, {} ); // $ExpectError - map.assign( x, y, 1, 0, false, {} ); // $ExpectError - map.assign( x, y, 1, 0, true, {} ); // $ExpectError - map.assign( x, y, 1, 0, null, {} ); // $ExpectError - map.assign( x, y, 1, 0, void 0, {} ); // $ExpectError - map.assign( x, y, 1, 0, {}, {} ); // $ExpectError - map.assign( x, y, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ 1, 2, 3 ]; - const y = [ 0, 0, 0 ]; - - map.assign(); // $ExpectError - map.assign( x ); // $ExpectError - map.assign( x, y ); // $ExpectError - map.assign( x, y, 1, 0 ); // $ExpectError - map.assign( x, y, 1, 0, fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 7be9856..0000000 --- a/examples/index.js +++ /dev/null @@ -1,32 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map = require( './../lib' ); - -var x = discreteUniform( 10, -10, 10, { - 'dtype': 'float64' -}); -console.log( x ); - -var y = map( x, naryFunction( abs, 1 ) ); -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 30460b3..2a8caa0 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, TypedArray } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..ee70f36 --- /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 r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.2-esm/index.mjs";function s(r,e,s,n,o,a){var c,i;return c=t(r),i=t(e),c.accessorProtocol||i.accessorProtocol?(function(r,e,t,s,n,o){var a,c,i,l,d,m;for(a=r.data,c=e.data,i=r.accessors[0],l=e.accessors[1],d=s,m=0;m [ 10.0, 10.0, 10.0, 10.0 ]\n*/\nfunction accessors( x, y, stride, offset, fcn, thisArg ) {\n\tvar xdata;\n\tvar ydata;\n\tvar xget;\n\tvar yset;\n\tvar io;\n\tvar i;\n\n\txdata = x.data;\n\tydata = y.data;\n\txget = x.accessors[ 0 ];\n\tyset = y.accessors[ 1 ];\n\n\tio = offset;\n\tfor ( i = 0; i < xdata.length; i++ ) {\n\t\tyset( ydata, io, fcn.call( thisArg, xget( xdata, i ), i, xdata ) );\n\t\tio += stride;\n\t}\n\treturn y;\n}\n\n\n// MAIN //\n\n/**\n* Applies a callback function to elements in an input array and assigns results to elements in an output array.\n*\n* @param {Collection} x - input array\n* @param {Collection} y - output array\n* @param {integer} stride - stride length for output array\n* @param {NonNegativeInteger} offset - starting index for output array\n* @param {Function} fcn - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import ones from '@stdlib/array-base-ones';\n* import zeros from '@stdlib/array-base-zeros';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var x = ones( 4 );\n* var y = zeros( x.length );\n*\n* var out = assign( x, y, 1, 0, scale );\n* // returns [ 10.0, 10.0, 10.0, 10.0 ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction assign( x, y, stride, offset, fcn, thisArg ) {\n\tvar xobj;\n\tvar yobj;\n\n\txobj = arraylike2object( x );\n\tyobj = arraylike2object( y );\n\tif ( xobj.accessorProtocol || yobj.accessorProtocol ) {\n\t\taccessors( xobj, yobj, stride, offset, fcn, thisArg );\n\t\treturn y;\n\t}\n\treturn internal( x, y, stride, offset, fcn, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default assign;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether an object has a specified method.\n*\n* @private\n* @param {Object} obj - input object\n* @param {string} method - method name\n* @returns {boolean} boolean indicating whether an object has a specified method\n*\n* @example\n* var bool = hasMethod( [], 'map' );\n* // returns true\n*\n* @example\n* var bool = hasMethod( [], 'beep' );\n* // returns false\n*/\nfunction hasMethod( obj, method ) {\n\treturn ( typeof obj[ method ] === 'function' );\n}\n\n\n// MAIN //\n\n/**\n* Applies a callback function to elements in an input array and assigns results to elements in a new output array.\n*\n* @param {Collection} x - input array\n* @param {Function} fcn - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import ones from '@stdlib/array-base-ones';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var x = ones( 4 );\n* var y = map( x, scale );\n* // returns [ 10.0, 10.0, 10.0, 10.0 ]\n*/\nfunction map( x, fcn, thisArg ) {\n\tif ( hasMethod( x, 'map' ) ) {\n\t\treturn x.map( fcn, thisArg );\n\t}\n\treturn assign( x, zeros( x.length ), 1, 0, fcn, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default map;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a callback function to elements in an input array and assign results to elements in a new output array.\n*\n* @module @stdlib/array-base-map\n*\n* @example\n* import ones from '@stdlib/array-base-ones';\n* import map from '@stdlib/array-base-map';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var x = ones( 4 );\n* var y = map( x, scale );\n* // returns [ 10.0, 10.0, 10.0, 10.0 ]\n*\n* @example\n* import ones from '@stdlib/array-base-ones';\n* import zeros from '@stdlib/array-base-zeros';\n* import map from '@stdlib/array-base-map';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var x = ones( 4 );\n* var y = zeros( x.length );\n*\n* var out = map.assign( x, y, 1, 0, scale );\n* // returns [ 10.0, 10.0, 10.0, 10.0 ]\n*\n* var bool = ( out === y );\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\n// exports: { \"assign\": \"main.assign\" }\n"],"names":["assign","x","y","stride","offset","fcn","thisArg","xobj","yobj","arraylike2object","accessorProtocol","xdata","ydata","xget","yset","io","i","data","accessors","length","call","internal","map","zeros","setReadOnly","main"],"mappings":";;yTAmJA,SAASA,EAAQC,EAAGC,EAAGC,EAAQC,EAAQC,EAAKC,GAC3C,IAAIC,EACAC,EAIJ,OAFAD,EAAOE,EAAkBR,GACzBO,EAAOC,EAAkBP,GACpBK,EAAKG,kBAAoBF,EAAKE,kBA1DpC,SAAoBT,EAAGC,EAAGC,EAAQC,EAAQC,EAAKC,GAC9C,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EAQJ,IANAL,EAAQV,EAAEgB,KACVL,EAAQV,EAAEe,KACVJ,EAAOZ,EAAEiB,UAAW,GACpBJ,EAAOZ,EAAEgB,UAAW,GAEpBH,EAAKX,EACCY,EAAI,EAAGA,EAAIL,EAAMQ,OAAQH,IAC9BF,EAAMF,EAAOG,EAAIV,EAAIe,KAAMd,EAASO,EAAMF,EAAOK,GAAKA,EAAGL,IACzDI,GAAMZ,CAGR,CAwCEe,CAAWX,EAAMC,EAAML,EAAQC,EAAQC,EAAKC,GACrCJ,GApGT,SAAmBD,EAAGC,EAAGC,EAAQC,EAAQC,EAAKC,GAC7C,IAAIS,EACAC,EAGJ,IADAD,EAAKX,EACCY,EAAI,EAAGA,EAAIf,EAAEkB,OAAQH,IAC1Bd,EAAGa,GAAOV,EAAIe,KAAMd,EAASL,EAAGe,GAAKA,EAAGf,GACxCc,GAAMZ,EAEP,OAAOD,CACR,CA4FQmB,CAAUpB,EAAGC,EAAGC,EAAQC,EAAQC,EAAKC,EAC7C,CCxFA,SAASgB,EAAKrB,EAAGI,EAAKC,GACrB,MA1BkC,mBA0BlBL,EAAG,OACXA,EAAEqB,IAAKjB,EAAKC,GAEbN,EAAQC,EAAGsB,EAAOtB,EAAEkB,QAAU,EAAG,EAAGd,EAAKC,EACjD,CCVAkB,EAAAC,EAAA,SAAAzB"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 3813aa8..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,164 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); - - -// FUNCTIONS // - -/** -* Applies a callback function to elements in an input array and assigns results to elements in an output array. -* -* @private -* @param {Collection} x - input array -* @param {Collection} y - output array -* @param {integer} stride - stride length for output array -* @param {NonNegativeInteger} offset - starting index for output array -* @param {Function} fcn - callback function -* @param {*} thisArg - callback execution context -* @returns {Collection} output array -* -* @example -* var ones = require( '@stdlib/array-base-ones' ); -* var zeros = require( '@stdlib/array-base-zeros' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var x = ones( 4 ); -* var y = zeros( x.length ); -* var out = internal( x, y, 1, 0, scale ); -* // returns [ 10.0, 10.0, 10.0, 10.0 ] -* -* var bool = ( out === y ); -* // returns true -*/ -function internal( x, y, stride, offset, fcn, thisArg ) { - var io; - var i; - - io = offset; - for ( i = 0; i < x.length; i++ ) { - y[ io ] = fcn.call( thisArg, x[ i ], i, x ); - io += stride; - } - return y; -} - -/** -* Applies a callback function to elements in an input array and assigns results to elements in an output array. -* -* @private -* @param {Object} x - input array object -* @param {Object} y - output array object -* @param {integer} stride - stride length for output array -* @param {NonNegativeInteger} offset - starting index for output array -* @param {Function} fcn - callback function -* @param {*} thisArg - callback execution context -* @returns {Object} output array object -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* var ones = require( '@stdlib/array-base-ones' ); -* var zeros = require( '@stdlib/array-base-zeros' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var x = ones( 4 ); -* var y = zeros( x.length ); -* -* var out = accessors( arraylike2object( toAccessorArray( x ) ), arraylike2object( toAccessorArray( y ) ), 1, 0, scale ); -* // y => [ 10.0, 10.0, 10.0, 10.0 ] -*/ -function accessors( x, y, stride, offset, fcn, thisArg ) { - var xdata; - var ydata; - var xget; - var yset; - var io; - var i; - - xdata = x.data; - ydata = y.data; - xget = x.accessors[ 0 ]; - yset = y.accessors[ 1 ]; - - io = offset; - for ( i = 0; i < xdata.length; i++ ) { - yset( ydata, io, fcn.call( thisArg, xget( xdata, i ), i, xdata ) ); - io += stride; - } - return y; -} - - -// MAIN // - -/** -* Applies a callback function to elements in an input array and assigns results to elements in an output array. -* -* @param {Collection} x - input array -* @param {Collection} y - output array -* @param {integer} stride - stride length for output array -* @param {NonNegativeInteger} offset - starting index for output array -* @param {Function} fcn - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var ones = require( '@stdlib/array-base-ones' ); -* var zeros = require( '@stdlib/array-base-zeros' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var x = ones( 4 ); -* var y = zeros( x.length ); -* -* var out = assign( x, y, 1, 0, scale ); -* // returns [ 10.0, 10.0, 10.0, 10.0 ] -* -* var bool = ( out === y ); -* // returns true -*/ -function assign( x, y, stride, offset, fcn, thisArg ) { - var xobj; - var yobj; - - xobj = arraylike2object( x ); - yobj = arraylike2object( y ); - if ( xobj.accessorProtocol || yobj.accessorProtocol ) { - accessors( xobj, yobj, stride, offset, fcn, thisArg ); - return y; - } - return internal( x, y, stride, offset, fcn, thisArg ); -} - - -// EXPORTS // - -module.exports = assign; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e934667..0000000 --- a/lib/index.js +++ /dev/null @@ -1,73 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a callback function to elements in an input array and assign results to elements in a new output array. -* -* @module @stdlib/array-base-map -* -* @example -* var ones = require( '@stdlib/array-base-ones' ); -* var map = require( '@stdlib/array-base-map' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var x = ones( 4 ); -* var y = map( x, scale ); -* // returns [ 10.0, 10.0, 10.0, 10.0 ] -* -* @example -* var ones = require( '@stdlib/array-base-ones' ); -* var zeros = require( '@stdlib/array-base-zeros' ); -* var map = require( '@stdlib/array-base-map' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var x = ones( 4 ); -* var y = zeros( x.length ); -* -* var out = map.assign( x, y, 1, 0, scale ); -* // returns [ 10.0, 10.0, 10.0, 10.0 ] -* -* var bool = ( out === y ); -* // 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; - -// exports: { "assign": "main.assign" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index cea5419..0000000 --- a/lib/main.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// FUNCTIONS // - -/** -* Tests whether an object has a specified method. -* -* @private -* @param {Object} obj - input object -* @param {string} method - method name -* @returns {boolean} boolean indicating whether an object has a specified method -* -* @example -* var bool = hasMethod( [], 'map' ); -* // returns true -* -* @example -* var bool = hasMethod( [], 'beep' ); -* // returns false -*/ -function hasMethod( obj, method ) { - return ( typeof obj[ method ] === 'function' ); -} - - -// MAIN // - -/** -* Applies a callback function to elements in an input array and assigns results to elements in a new output array. -* -* @param {Collection} x - input array -* @param {Function} fcn - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var ones = require( '@stdlib/array-base-ones' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var x = ones( 4 ); -* var y = map( x, scale ); -* // returns [ 10.0, 10.0, 10.0, 10.0 ] -*/ -function map( x, fcn, thisArg ) { - if ( hasMethod( x, 'map' ) ) { - return x.map( fcn, thisArg ); - } - return assign( x, zeros( x.length ), 1, 0, fcn, thisArg ); -} - - -// EXPORTS // - -module.exports = map; diff --git a/package.json b/package.json index 8ddec67..a976549 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Apply a callback function to elements in an input array and assign results to elements in a new output array.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.2", - "@stdlib/array-base-zeros": "^0.2.3", - "@stdlib/types": "^0.5.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-to-accessor-array": "^0.2.3", - "@stdlib/array-float64": "^0.2.3", - "@stdlib/assert-is-array": "^0.2.3", - "@stdlib/assert-is-float64array": "^0.2.3", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/math-base-special-abs": "^0.2.3", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/number-float64-base-identity": "^0.1.1", - "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@stdlib/random-array-uniform": "^0.2.2", - "@stdlib/string-format": "^0.2.3", - "@stdlib/utils-nary-function": "^0.2.4", - "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", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..4cfec65 --- /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 87cf4dd..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,433 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var Float64Array = require( '@stdlib/array-float64' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var map = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to elements in an input array and assigns results to elements in an output array (generic)', function test( t ) { - var expected; - var out; - var x; - var y; - - x = [ 1, 2, 3, 4 ]; - y = zeros( x.length ); - expected = [ 10, 20, 30, 40 ]; - - out = map( x, y, 1, 0, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10; - } -}); - -tape( 'the function applies a provided callback to elements in an input array and assigns results to elements in an output array (typed array)', function test( t ) { - var expected; - var out; - var x; - var y; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - y = new Float64Array( x.length ); - expected = new Float64Array( [ 10.0, 20.0, 30.0, 40.0 ] ); - - out = map( x, y, 1, 0, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10.0; - } -}); - -tape( 'the function applies a provided callback to elements in an input array and assigns results to elements in an output array (accessors)', function test( t ) { - var expected; - var ybuf; - var out; - var x; - var y; - - x = [ 1, 2, 3, 4 ]; - ybuf = zeros( x.length ); - y = toAccessorArray( ybuf ); - - expected = [ 10, 20, 30, 40 ]; - - out = map( toAccessorArray( x ), y, 1, 0, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( ybuf, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10; - } -}); - -tape( 'the function applies a provided callback to elements in an input array and assigns results to elements in an output array (array-like object)', function test( t ) { - var expected; - var out; - var x; - var y; - - x = { - 'length': 4, - '0': 1, - '1': 2, - '2': 3, - '3': 4 - }; - y = zeros( x.length ); - expected = [ 10, 20, 30, 40 ]; - - out = map( x, y, 1, 0, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10; - } -}); - -tape( 'the function supports providing an execution context', function test( t ) { - var expected; - var out; - var ctx; - var x; - var y; - - x = [ 1, 2, 3, 4 ]; - y = zeros( x.length ); - ctx = { - 'factor': 10 - }; - expected = [ 10, 20, 30, 40 ]; - - out = map( x, y, 1, 0, scale, ctx ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * this.factor; // eslint-disable-line no-invalid-this - } -}); - -tape( 'the function supports providing a `stride` parameter (generic)', function test( t ) { - var expected; - var out; - var x; - var y; - - x = [ 1, 2, 3, 4 ]; - y = zeros( x.length * 2 ); - expected = [ 10, 0, 20, 0, 30, 0, 40, 0 ]; - - out = map( x, y, 2, 0, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10; - } -}); - -tape( 'the function supports providing a `stride` parameter (typed array)', function test( t ) { - var expected; - var out; - var x; - var y; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - y = new Float64Array( x.length * 2 ); - expected = new Float64Array( [ 10.0, 0.0, 20.0, 0.0, 30.0, 0.0, 40.0, 0.0 ] ); // eslint-disable-line max-len - - out = map( x, y, 2, 0, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10.0; - } -}); - -tape( 'the function supports providing a `stride` parameter (accessors)', function test( t ) { - var expected; - var ybuf; - var out; - var x; - var y; - - x = [ 1, 2, 3, 4 ]; - ybuf = zeros( x.length * 2 ); - y = toAccessorArray( ybuf ); - - expected = [ 10, 0, 20, 0, 30, 0, 40, 0 ]; - - out = map( toAccessorArray( x ), y, 2, 0, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( ybuf, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10; - } -}); - -tape( 'the function supports providing a `stride` parameter (array-like object)', function test( t ) { - var expected; - var out; - var x; - var y; - - x = { - 'length': 4, - '0': 1, - '1': 2, - '2': 3, - '3': 4 - }; - y = zeros( x.length * 2 ); - expected = [ 10, 0, 20, 0, 30, 0, 40, 0 ]; - - out = map( x, y, 2, 0, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10; - } -}); - -tape( 'the function supports providing a negative `stride` parameter (generic)', function test( t ) { - var expected; - var out; - var x; - var y; - - x = [ 1, 2, 3, 4 ]; - y = zeros( x.length ); - expected = [ 40, 30, 20, 10 ]; - - out = map( x, y, -1, 3, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10; - } -}); - -tape( 'the function supports providing a negative `stride` parameter (typed array)', function test( t ) { - var expected; - var out; - var x; - var y; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - y = new Float64Array( x.length ); - expected = new Float64Array( [ 40, 30, 20, 10 ] ); - - out = map( x, y, -1, 3, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10.0; - } -}); - -tape( 'the function supports providing a negative `stride` parameter (accessors)', function test( t ) { - var expected; - var ybuf; - var out; - var x; - var y; - - x = [ 1, 2, 3, 4 ]; - ybuf = zeros( x.length ); - y = toAccessorArray( ybuf ); - - expected = [ 40, 30, 20, 10 ]; - - out = map( toAccessorArray( x ), y, -1, 3, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( ybuf, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10; - } -}); - -tape( 'the function supports providing a negative `stride` parameter (array-like object)', function test( t ) { - var expected; - var out; - var x; - var y; - - x = { - 'length': 4, - '0': 1, - '1': 2, - '2': 3, - '3': 4 - }; - y = zeros( x.length ); - expected = [ 40, 30, 20, 10 ]; - - out = map( x, y, -1, 3, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10; - } -}); - -tape( 'the function supports providing an `offset` parameter (generic)', function test( t ) { - var expected; - var out; - var x; - var y; - - x = [ 1, 2, 3, 4 ]; - y = zeros( x.length * 2 ); - expected = [ 0, 10, 0, 20, 0, 30, 0, 40 ]; - - out = map( x, y, 2, 1, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10; - } -}); - -tape( 'the function supports providing an `offset` parameter (typed array)', function test( t ) { - var expected; - var out; - var x; - var y; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - y = new Float64Array( x.length * 2 ); - expected = new Float64Array( [ 0.0, 10.0, 0.0, 20.0, 0.0, 30.0, 0.0, 40.0 ] ); // eslint-disable-line max-len - - out = map( x, y, 2, 1, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10.0; - } -}); - -tape( 'the function supports providing an `offset` parameter (accessors)', function test( t ) { - var expected; - var ybuf; - var out; - var x; - var y; - - x = [ 1, 2, 3, 4 ]; - ybuf = zeros( x.length * 2 ); - y = toAccessorArray( ybuf ); - - expected = [ 0, 10, 0, 20, 0, 30, 0, 40 ]; - - out = map( toAccessorArray( x ), y, 2, 1, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( ybuf, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10; - } -}); - -tape( 'the function supports providing an `offset` parameter (array-like object)', function test( t ) { - var expected; - var out; - var x; - var y; - - x = { - 'length': 4, - '0': 1, - '1': 2, - '2': 3, - '3': 4 - }; - y = zeros( x.length * 2 ); - expected = [ 0, 10, 0, 20, 0, 30, 0, 40 ]; - - out = map( x, y, 2, 1, scale ); - - t.strictEqual( out, y, 'returns expected value' ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 654cd9c..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var map = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 5c91656..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,142 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var Float64Array = require( '@stdlib/array-float64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var map = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to elements in an input array and assigns results to elements in a new output array (generic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - expected = [ 10, 20, 30, 40 ]; - - actual = map( x, scale ); - - t.strictEqual( isArray( actual ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10; - } -}); - -tape( 'the function applies a provided callback to elements in an input array and assigns results to elements in a new output array (typed array)', function test( t ) { - var expected; - var actual; - var x; - - x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - expected = new Float64Array( [ 10.0, 20.0, 30.0, 40.0 ] ); - - actual = map( x, scale ); - - t.strictEqual( isFloat64Array( actual ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10.0; - } -}); - -tape( 'the function applies a provided callback to elements in an input array and assigns results to elements in a new output array (accessors)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - expected = [ 10, 20, 30, 40 ]; - - actual = map( toAccessorArray( x ), scale ); - - t.strictEqual( isArray( actual ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10; - } -}); - -tape( 'the function applies a provided callback to elements in an input array and assigns results to elements in a new output array (array-like object)', function test( t ) { - var expected; - var actual; - var x; - - x = { - 'length': 4, - '0': 1, - '1': 2, - '2': 3, - '3': 4 - }; - expected = [ 10, 20, 30, 40 ]; - - actual = map( x, scale ); - - t.strictEqual( isArray( actual ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * 10; - } -}); - -tape( 'the function supports providing an execution context', function test( t ) { - var expected; - var actual; - var ctx; - var x; - - x = [ 1, 2, 3, 4 ]; - ctx = { - 'factor': 10 - }; - expected = [ 10, 20, 30, 40 ]; - - actual = map( x, scale, ctx ); - - t.strictEqual( isArray( actual ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function scale( v ) { - return v * this.factor; // eslint-disable-line no-invalid-this - } -});