diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0779e8a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 804125d..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-12-30T02:15:18.309Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 817f873..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/place) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 385e3ac..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/place) 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 f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -200,7 +191,7 @@ console.log( out ); ## 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]. @@ -263,19 +254,19 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-place/main/LICENSE -[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes +[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes/tree/esm -[@stdlib/array/safe-casts]: https://github.com/stdlib-js/array-safe-casts +[@stdlib/array/safe-casts]: https://github.com/stdlib-js/array-safe-casts/tree/esm -[@stdlib/array/same-kind-casts]: https://github.com/stdlib-js/array-same-kind-casts +[@stdlib/array/same-kind-casts]: https://github.com/stdlib-js/array-same-kind-casts/tree/esm -[@stdlib/array/mskput]: https://github.com/stdlib-js/array-mskput +[@stdlib/array/mskput]: https://github.com/stdlib-js/array-mskput/tree/esm -[@stdlib/array/put]: https://github.com/stdlib-js/array-put +[@stdlib/array/put]: https://github.com/stdlib-js/array-put/tree/esm -[@stdlib/array/take]: https://github.com/stdlib-js/array-take +[@stdlib/array/take]: https://github.com/stdlib-js/array-take/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index f9e5b61..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,79 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isArray = require( '@stdlib/assert-is-array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var ones = require( '@stdlib/array-base-ones' ); -var pkg = require( './../package.json' ).name; -var place = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::no_broadcasting:len=100', function benchmark( b ) { - var mask; - var x; - var i; - var v; - - x = zeroTo( 100 ); - mask = ones( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = place( x, mask, x ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::broadcasting:len=100', function benchmark( b ) { - var mask; - var x; - var i; - var v; - - x = zeroTo( 100 ); - mask = ones( 100 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = place( x, mask, [ i ] ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index e03e3cf..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,113 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var ones = require( '@stdlib/array-base-ones' ); -var isArray = require( '@stdlib/assert-is-array' ); -var pkg = require( './../package.json' ).name; -var place = require( './../lib' ); - - -// VARIABLES // - -var opts = { - 'dtype': 'generic' -}; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var values; - var mask; - var x; - - x = discreteUniform( len, 0, 10, opts ); - mask = ones( len ); - values = [ - discreteUniform( len, -10, 0, opts ), - discreteUniform( len, 0, 10, opts ) - ]; - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var v; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = place( x, mask, values[ i%values.length ] ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6461830..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/place" -%% click B href "https://github.com/stdlib-js/array-place/tree/main" -%% click C href "https://github.com/stdlib-js/array-place/tree/production" -%% click D href "https://github.com/stdlib-js/array-place/tree/esm" -%% click E href "https://github.com/stdlib-js/array-place/tree/deno" -%% click F href "https://github.com/stdlib-js/array-place/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/place -[production-url]: https://github.com/stdlib-js/array-place/tree/production -[deno-url]: https://github.com/stdlib-js/array-place/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-place/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-place/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-place/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-place/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-place/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 0fdaab3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import place from '../docs/types/index'; -export = place; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index fa700bd..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var s=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var m=s(function(P,c){ -function b(){return{mode:"repeat"}}c.exports=b -});var p=s(function(R,f){ -var w=require('@stdlib/assert-is-plain-object/dist'),h=require('@stdlib/assert-has-own-property/dist'),T=require('@stdlib/array-base-assert-contains/dist').factory,v=require('@stdlib/error-tools-fmtprodmsg/dist'),l=["strict","non_strict","strict_broadcast","broadcast","repeat"],E=T(l);function j(e,r){return w(r)?h(r,"mode")&&(e.mode=r.mode,!E(e.mode))?new TypeError(v('1wP4S',"mode",l.join('", "'),e.mode)):null:new TypeError(v('1wP2V',r));}f.exports=j -});var q=s(function(z,g){ -var O=require('@stdlib/array-base-assert-is-mostly-safe-data-type-cast/dist'),D=require('@stdlib/array-base-assert-is-real-data-type/dist'),V=require('@stdlib/array-base-assert-is-complex-floating-point-data-type/dist'),d=require('@stdlib/assert-is-collection/dist'),x=require('@stdlib/array-base-place/dist'),y=require('@stdlib/array-dtype/dist'),C=require('@stdlib/array-convert/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),M=m(),S=p();function _(e,r,t){var o,u,a,i;if(!d(e))throw new TypeError(n('1wP2O',e));if(!d(r))throw new TypeError(n('1wP2y',r));if(!d(t))throw new TypeError(n('1wP2l',t));if(o=M(),arguments.length>3&&(u=S(o,arguments[3]),u))throw u;if(a=y(e)||"generic",i=y(t)||"generic",!O(i,a))throw new TypeError(n('1wPFu',i,a));return V(a)&&D(i)&&(t=C(t,a)),x(e,r,t,o.mode)}g.exports=_ -});var k=q();module.exports=k; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 816397a..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.js", "../lib/validate.js", "../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Returns default options.\n*\n* @private\n* @returns {Object} default options\n*\n* @example\n* var o = defaults();\n* // returns {...}\n*/\nfunction defaults() {\n\treturn {\n\t\t'mode': 'repeat'\n\t};\n}\n\n\n// EXPORTS //\n\nmodule.exports = defaults;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar contains = require( '@stdlib/array-base-assert-contains' ).factory;\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar MODES = [\n\t'strict',\n\t'non_strict',\n\t'strict_broadcast',\n\t'broadcast',\n\t'repeat'\n];\nvar isMode = contains( MODES );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - mode option\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'strict'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'mode', MODES.join( '\", \"' ), opts.mode ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isMostlySafeCast = require( '@stdlib/array-base-assert-is-mostly-safe-data-type-cast' );\nvar isRealDataType = require( '@stdlib/array-base-assert-is-real-data-type' );\nvar isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' );\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar base = require( '@stdlib/array-base-place' );\nvar dtype = require( '@stdlib/array-dtype' );\nvar convert = require( '@stdlib/array-convert' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.js' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Replaces elements of an array with provided values according to a provided mask array.\n*\n* @param {Collection} x - input array\n* @param {Collection} mask - mask array\n* @param {Collection} values - values to set\n* @param {Options} [options] - function options\n* @param {string} [options.mode='repeat'] - string specifying behavior when the number of values does not equal the number of truthy mask values\n* @throws {TypeError} first argument must be a collection\n* @throws {TypeError} second argument must be a collection\n* @throws {TypeError} third argument must be a collection\n* @throws {TypeError} options argument must be an object\n* @throws {Error} must provide valid options\n* @throws {Error} insufficient values to satisfy mask array\n* @throws {Error} number of values does not equal the number of truthy mask values\n* @throws {TypeError} third argument cannot be safely cast to the data type of the first argument\n* @returns {Collection} input array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n*\n* var mask = [ 0, 1, 1, 0 ];\n* var values = [ 20, 30 ];\n*\n* var out = place( x, mask, values );\n* // returns [ 1, 20, 30, 4 ]\n*\n* var bool = ( out === x );\n* // returns true\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n*\n* var mask = [ 0, 1, 1, 0 ];\n* var values = [ 30 ];\n*\n* var out = place( x, mask, values );\n* // returns [ 1, 30, 30, 4 ]\n*\n* var bool = ( out === x );\n* // returns true\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n*\n* var mask = [ 1, 1, 0, 1 ];\n* var values = [ 20, 30 ];\n*\n* var out = place( x, mask, values );\n* // returns [ 20, 30, 3, 20 ]\n*\n* var bool = ( out === x );\n* // returns true\n*/\nfunction place( x, mask, values ) {\n\tvar opts;\n\tvar err;\n\tvar xdt;\n\tvar vdt;\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( mask ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array-like object. Value: `%s`.', mask ) );\n\t}\n\tif ( !isCollection( values ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', values ) );\n\t}\n\topts = defaults();\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, arguments[ 3 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\txdt = dtype( x ) || 'generic';\n\tvdt = dtype( values ) || 'generic';\n\n\t// Safe casts are always allowed and allow same kind casts (i.e., downcasts) only when the input array data type is floating-point...\n\tif ( !isMostlySafeCast( vdt, xdt ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument cannot be safely cast to the input array data type. Data types: [%s, %s].', vdt, xdt ) );\n\t}\n\t// When performing a real-to-complex assignment, interpret the real-valued array as containing real components with implied imaginary components equal to zero and explicitly convert to a complex-valued array...\n\tif ( isComplexDataType( xdt ) && isRealDataType( vdt ) ) {\n\t\tvalues = convert( values, xdt );\n\t}\n\t// Replace values in the input array:\n\treturn base( x, mask, values, opts.mode );\n}\n\n\n// EXPORTS //\n\nmodule.exports = place;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Replace elements of an array with provided values according to a provided mask array.\n*\n* @module @stdlib/array-place\n*\n* @example\n* var place = require( '@stdlib/array-place' );\n*\n* var x = [ 1, 2, 3, 4 ];\n*\n* var mask = [ 0, 1, 1, 0 ];\n* var values = [ 20, 30 ];\n*\n* var out = place( x, mask, values );\n* // returns [ 1, 20, 30, 4 ]\n*\n* var bool = ( out === x );\n* // returns true\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAgCA,SAASC,GAAW,CACnB,MAAO,CACN,KAAQ,QACT,CACD,CAKAD,EAAO,QAAUC,ICzCjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EAAE,QAC3DC,EAAS,QAAS,uBAAwB,EAK1CC,EAAQ,CACX,SACA,aACA,mBACA,YACA,QACD,EACIC,EAASH,EAAUE,CAAM,EAwB7B,SAASE,EAAUC,EAAMC,EAAU,CAClC,OAAMR,EAAUQ,CAAQ,EAGnBP,EAAYO,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACH,EAAQE,EAAK,IAAK,GAChB,IAAI,UAAWJ,EAAQ,gFAAiF,OAAQC,EAAM,KAAM,MAAO,EAAGG,EAAK,IAAK,CAAE,EAGpJ,KARC,IAAI,UAAWJ,EAAQ,qEAAsEK,CAAQ,CAAE,CAShH,CAKAT,EAAO,QAAUO,IC7EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,yDAA0D,EACtFC,EAAiB,QAAS,6CAA8C,EACxEC,EAAoB,QAAS,+DAAgE,EAC7FC,EAAe,QAAS,8BAA+B,EACvDC,EAAO,QAAS,0BAA2B,EAC3CC,EAAQ,QAAS,qBAAsB,EACvCC,EAAU,QAAS,uBAAwB,EAC3CC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IA2Df,SAASC,EAAOC,EAAGC,EAAMC,EAAS,CACjC,IAAIC,EACAC,EACAC,EACAC,EACJ,GAAK,CAACd,EAAcQ,CAAE,EACrB,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAE,CAAE,EAEjH,GAAK,CAACR,EAAcS,CAAK,EACxB,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAK,CAAE,EAErH,GAAK,CAACT,EAAcU,CAAO,EAC1B,MAAM,IAAI,UAAWN,EAAQ,8EAA+EM,CAAO,CAAE,EAGtH,GADAC,EAAON,EAAS,EACX,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAM,UAAW,CAAE,CAAE,EAChCC,GACJ,MAAMA,EAOR,GAJAC,EAAMX,EAAOM,CAAE,GAAK,UACpBM,EAAMZ,EAAOQ,CAAO,GAAK,UAGpB,CAACb,EAAkBiB,EAAKD,CAAI,EAChC,MAAM,IAAI,UAAWT,EAAQ,6GAA8GU,EAAKD,CAAI,CAAE,EAGvJ,OAAKd,EAAmBc,CAAI,GAAKf,EAAgBgB,CAAI,IACpDJ,EAASP,EAASO,EAAQG,CAAI,GAGxBZ,EAAMO,EAAGC,EAAMC,EAAQC,EAAK,IAAK,CACzC,CAKAf,EAAO,QAAUW,ICvFjB,IAAIQ,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "defaults", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "MODES", "isMode", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isMostlySafeCast", "isRealDataType", "isComplexDataType", "isCollection", "base", "dtype", "convert", "format", "defaults", "validate", "place", "x", "mask", "values", "opts", "err", "xdt", "vdt", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index e9816ac..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,68 +0,0 @@ - -{{alias}}( x, mask, values[, options] ) - Replaces elements of an array with provided values according to a provided - mask array. - - In broadcasting modes, the function supports broadcasting a values array - containing a single element against the number of truthy values in the mask - array. - - In repeat mode, the function supports recycling elements in a values array - to satisfy the number of truthy values in the mask array. - - The function mutates the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - mask: ArrayLikeObject - Mask array. If a mask array element is truthy, the corresponding element - in `x` is *replaced*; otherwise, the corresponding element in `x` is - "masked" and thus left unchanged. - - values: ArrayLikeObject - Values to set. - - options: Object (optional) - Function options. - - options.mode: string (optional) - String specifying behavior when the number of values to set does not - equal the number of truthy mask values. The function supports the - following modes: - - - 'strict': specifies that the function must raise an exception when the - number of values does not *exactly* equal the number of truthy mask - values. - - 'non_strict': specifies that the function must raise an exception when - the function is provided insufficient values to satisfy the mask array. - - 'strict_broadcast': specifies that the function must broadcast a - single-element values array and otherwise raise an exception when the - number of values does not **exactly** equal the number of truthy mask - values. - - 'broadcast': specifies that the function must broadcast a single- - element values array and otherwise raise an exception when the function - is provided insufficient values to satisfy the mask array. - - 'repeat': specifies that the function must reuse provided values when - replacing elements in `x` in order to satisfy the mask array. - - Default: 'repeat'. - - Returns - ------- - out: ArrayLikeObject - Input array. - - Examples - -------- - > var x = [ 1, 2, 3, 4 ]; - > var out = {{alias}}( x, [ 0, 1, 0, 1 ], [ 20, 40 ] ) - [ 1, 20, 3, 40 ] - > var bool = ( out === x ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index b569bbe..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,96 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import Complex128Array = require( '@stdlib/array-complex128' ); -import Complex64Array = require( '@stdlib/array-complex64' ); -import Complex128 = require( '@stdlib/complex-float64-ctor' ); -import AccessorArray = require( '@stdlib/array-base-accessor' ); -import place = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - place( [ 1, 2, 3, 4 ], [ 1, 0, 0, 1 ], [ 20, 30 ] ); // $ExpectType number[] - place( new Int32Array( [ 1, 2, 3, 4 ] ), [ 1, 0, 0, 1 ], [ 20, 30 ] ); // $ExpectType Int32Array - place( new Complex128Array( [ 1, 2, 3, 4 ] ), [ 1, 0, 0, 1 ], [ new Complex128( 20, 30 ), [ 40, 50 ] ] ); // $ExpectType Complex128Array - place( new Complex64Array( [ 1, 2, 3, 4 ] ), [ 1, 0, 0, 1 ], [ new Complex128( 20, 30 ), [ 40, 50 ] ] ); // $ExpectType Complex64Array - place( new AccessorArray( [ 1, 2, 3, 4 ] ), [ 1, 0, 0, 1 ], new AccessorArray( [ 20, 30 ] ) ); // $ExpectType AccessorArrayLike -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - place( 1, [ 1, 0, 0, 1 ], [ 20, 30 ] ); // $ExpectError - place( true, [ 1, 0, 0, 1 ], [ 20, 30 ] ); // $ExpectError - place( false, [ 1, 0, 0, 1 ], [ 20, 30 ] ); // $ExpectError - place( null, [ 1, 0, 0, 1 ], [ 20, 30 ] ); // $ExpectError - place( void 0, [ 1, 0, 0, 1 ], [ 20, 30 ] ); // $ExpectError - place( {}, [ 1, 0, 0, 1 ], [ 20, 30 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object... -{ - place( [], 1, [ 20, 30 ] ); // $ExpectError - place( [], true, [ 20, 30 ] ); // $ExpectError - place( [], false, [ 20, 30 ] ); // $ExpectError - place( [], null, [ 20, 30 ] ); // $ExpectError - place( [], void 0, [ 20, 30 ] ); // $ExpectError - place( [], {}, [ 20, 30 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an array-like object... -{ - place( [], [ 1, 0, 0, 1 ], 1 ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], true ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], false ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], null ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], void 0 ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not an object... -{ - place( [], [ 1, 0, 0, 1 ], [ 20, 30 ], '1' ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], [ 20, 30 ], 1 ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], [ 20, 30 ], true ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], [ 20, 30 ], false ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], [ 20, 30 ], null ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], [ 20, 30 ], [] ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], [ 20, 30 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a valid mode... -{ - place( [], [ 1, 0, 0, 1 ], [ 20, 30 ], { 'mode': '1' } ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], [ 20, 30 ], { 'mode': 1 } ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], [ 20, 30 ], { 'mode': true } ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], [ 20, 30 ], { 'mode': false } ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], [ 20, 30 ], { 'mode': null } ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], [ 20, 30 ], { 'mode': {} } ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], [ 20, 30 ], { 'mode': [] } ); // $ExpectError - place( [], [ 1, 0, 0, 1 ], [ 20, 30 ], { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - place(); // $ExpectError - place( [] ); // $ExpectError - place( [], [] ); // $ExpectError - place( [], [], [], {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a5a5702..0000000 --- a/examples/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var filledBy = require( '@stdlib/array-base-filled-by' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ); -var bernoulli = require( '@stdlib/random-base-bernoulli' ); -var linspace = require( '@stdlib/array-base-linspace' ); -var place = require( './../lib' ); - -// Generate a linearly spaced array: -var x = linspace( 0, 100, 11 ); -console.log( x ); - -// Generate a random mask array: -var N = discreteUniform( 5, 15 ); -var mask = filledBy( N, bernoulli.factory( 0.3 ) ); -console.log( mask ); - -// Generate an array of random values: -var values = filledBy( N, discreteUniform.factory( 1000, 2000 ) ); -console.log( values ); - -// Update a random sample of elements in `x`: -var out = place( x, mask, values ); -console.log( out ); 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 7800092..6ec4fe9 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, TypedArray, ComplexTypedArray, BooleanTypedArray } from '@stdlib/types/array'; import { ComplexLike } from '@stdlib/types/complex'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..fc86e6e --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-mostly-safe-data-type-cast@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-real-data-type@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-is-complex-floating-point-data-type@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-place@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.3.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";import{factory as l}from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.2-esm/index.mjs";var p=["strict","non_strict","strict_broadcast","broadcast","repeat"],j=l(p);function h(l,h,c){var v,y,f,b;if(!r(l))throw new TypeError(d("null2O",l));if(!r(h))throw new TypeError(d("null2y",h));if(!r(c))throw new TypeError(d("null2l",c));if(v={mode:"repeat"},arguments.length>3&&(y=function(t,e){return a(e)?m(e,"mode")&&(t.mode=e.mode,!j(t.mode))?new TypeError(d("null4S","mode",p.join('", "'),t.mode)):null:new TypeError(d("null2V",e))}(v,arguments[3]),y))throw y;if(f=n(l)||"generic",b=n(c)||"generic",!t(b,f))throw new TypeError(d("invalid argument. Third argument cannot be safely cast to the input array data type. Data types: [%s, %s].",b,f));return s(f)&&e(b)&&(c=o(c,f)),i(l,h,c,v.mode)}export{h as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..0ae7490 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/defaults.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport { factory as contains } from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar MODES = [\n\t'strict',\n\t'non_strict',\n\t'strict_broadcast',\n\t'broadcast',\n\t'repeat'\n];\nvar isMode = contains( MODES );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - mode option\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'strict'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'null4S', 'mode', MODES.join( '\", \"' ), opts.mode ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isMostlySafeCast from '@stdlib/array-base-assert-is-mostly-safe-data-type-cast';\nimport isRealDataType from '@stdlib/array-base-assert-is-real-data-type';\nimport isComplexDataType from '@stdlib/array-base-assert-is-complex-floating-point-data-type';\nimport isCollection from '@stdlib/assert-is-collection';\nimport base from '@stdlib/array-base-place';\nimport dtype from '@stdlib/array-dtype';\nimport convert from '@stdlib/array-convert';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.js';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Replaces elements of an array with provided values according to a provided mask array.\n*\n* @param {Collection} x - input array\n* @param {Collection} mask - mask array\n* @param {Collection} values - values to set\n* @param {Options} [options] - function options\n* @param {string} [options.mode='repeat'] - string specifying behavior when the number of values does not equal the number of truthy mask values\n* @throws {TypeError} first argument must be a collection\n* @throws {TypeError} second argument must be a collection\n* @throws {TypeError} third argument must be a collection\n* @throws {TypeError} options argument must be an object\n* @throws {Error} must provide valid options\n* @throws {Error} insufficient values to satisfy mask array\n* @throws {Error} number of values does not equal the number of truthy mask values\n* @throws {TypeError} third argument cannot be safely cast to the data type of the first argument\n* @returns {Collection} input array\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n*\n* var mask = [ 0, 1, 1, 0 ];\n* var values = [ 20, 30 ];\n*\n* var out = place( x, mask, values );\n* // returns [ 1, 20, 30, 4 ]\n*\n* var bool = ( out === x );\n* // returns true\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n*\n* var mask = [ 0, 1, 1, 0 ];\n* var values = [ 30 ];\n*\n* var out = place( x, mask, values );\n* // returns [ 1, 30, 30, 4 ]\n*\n* var bool = ( out === x );\n* // returns true\n*\n* @example\n* var x = [ 1, 2, 3, 4 ];\n*\n* var mask = [ 1, 1, 0, 1 ];\n* var values = [ 20, 30 ];\n*\n* var out = place( x, mask, values );\n* // returns [ 20, 30, 3, 20 ]\n*\n* var bool = ( out === x );\n* // returns true\n*/\nfunction place( x, mask, values ) {\n\tvar opts;\n\tvar err;\n\tvar xdt;\n\tvar vdt;\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'null2O', x ) );\n\t}\n\tif ( !isCollection( mask ) ) {\n\t\tthrow new TypeError( format( 'null2y', mask ) );\n\t}\n\tif ( !isCollection( values ) ) {\n\t\tthrow new TypeError( format( 'null2l', values ) );\n\t}\n\topts = defaults();\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, arguments[ 3 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\txdt = dtype( x ) || 'generic';\n\tvdt = dtype( values ) || 'generic';\n\n\t// Safe casts are always allowed and allow same kind casts (i.e., downcasts) only when the input array data type is floating-point...\n\tif ( !isMostlySafeCast( vdt, xdt ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument cannot be safely cast to the input array data type. Data types: [%s, %s].', vdt, xdt ) );\n\t}\n\t// When performing a real-to-complex assignment, interpret the real-valued array as containing real components with implied imaginary components equal to zero and explicitly convert to a complex-valued array...\n\tif ( isComplexDataType( xdt ) && isRealDataType( vdt ) ) {\n\t\tvalues = convert( values, xdt );\n\t}\n\t// Replace values in the input array:\n\treturn base( x, mask, values, opts.mode );\n}\n\n\n// EXPORTS //\n\nexport default place;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Returns default options.\n*\n* @private\n* @returns {Object} default options\n*\n* @example\n* var o = defaults();\n* // returns {...}\n*/\nfunction defaults() {\n\treturn {\n\t\t'mode': 'repeat'\n\t};\n}\n\n\n// EXPORTS //\n\nexport default defaults;\n"],"names":["MODES","isMode","contains","place","x","mask","values","opts","err","xdt","vdt","isCollection","TypeError","format","mode","arguments","length","options","isObject","hasOwnProp","join","validate","dtype","isMostlySafeCast","isComplexDataType","isRealDataType","convert","base"],"mappings":";;omCA8BA,IAAIA,EAAQ,CACX,SACA,aACA,mBACA,YACA,UAEGC,EAASC,EAAUF,GCqDvB,SAASG,EAAOC,EAAGC,EAAMC,GACxB,IAAIC,EACAC,EACAC,EACAC,EACJ,IAAMC,EAAcP,GACnB,MAAM,IAAIQ,UAAWC,EAAQ,SAAUT,IAExC,IAAMO,EAAcN,GACnB,MAAM,IAAIO,UAAWC,EAAQ,SAAUR,IAExC,IAAMM,EAAcL,GACnB,MAAM,IAAIM,UAAWC,EAAQ,SAAUP,IAGxC,GADAC,ECvEO,CACNO,KAAQ,UDuEJC,UAAUC,OAAS,IACvBR,ED7CF,SAAmBD,EAAMU,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBV,EAAKO,KAAOG,EAAQH,MACdb,EAAQM,EAAKO,OACX,IAAIF,UAAWC,EAAQ,SAAU,OAAQb,EAAMoB,KAAM,QAAUb,EAAKO,OAGtE,KARC,IAAIF,UAAWC,EAAQ,SAAUI,GAS1C,CCkCQI,CAAUd,EAAMQ,UAAW,IAC5BP,GACJ,MAAMA,EAOR,GAJAC,EAAMa,EAAOlB,IAAO,UACpBM,EAAMY,EAAOhB,IAAY,WAGnBiB,EAAkBb,EAAKD,GAC5B,MAAM,IAAIG,UAAWC,EAAQ,6GAA8GH,EAAKD,IAOjJ,OAJKe,EAAmBf,IAASgB,EAAgBf,KAChDJ,EAASoB,EAASpB,EAAQG,IAGpBkB,EAAMvB,EAAGC,EAAMC,EAAQC,EAAKO,KACpC"} \ No newline at end of file diff --git a/lib/defaults.js b/lib/defaults.js deleted file mode 100644 index ae98515..0000000 --- a/lib/defaults.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Returns default options. -* -* @private -* @returns {Object} default options -* -* @example -* var o = defaults(); -* // returns {...} -*/ -function defaults() { - return { - 'mode': 'repeat' - }; -} - - -// EXPORTS // - -module.exports = defaults; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 9e168c4..0000000 --- a/lib/index.js +++ /dev/null @@ -1,48 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Replace elements of an array with provided values according to a provided mask array. -* -* @module @stdlib/array-place -* -* @example -* var place = require( '@stdlib/array-place' ); -* -* var x = [ 1, 2, 3, 4 ]; -* -* var mask = [ 0, 1, 1, 0 ]; -* var values = [ 20, 30 ]; -* -* var out = place( x, mask, values ); -* // returns [ 1, 20, 30, 4 ] -* -* var bool = ( out === x ); -* // returns true -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6b8c92a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,130 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isMostlySafeCast = require( '@stdlib/array-base-assert-is-mostly-safe-data-type-cast' ); -var isRealDataType = require( '@stdlib/array-base-assert-is-real-data-type' ); -var isComplexDataType = require( '@stdlib/array-base-assert-is-complex-floating-point-data-type' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var base = require( '@stdlib/array-base-place' ); -var dtype = require( '@stdlib/array-dtype' ); -var convert = require( '@stdlib/array-convert' ); -var format = require( '@stdlib/string-format' ); -var defaults = require( './defaults.js' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Replaces elements of an array with provided values according to a provided mask array. -* -* @param {Collection} x - input array -* @param {Collection} mask - mask array -* @param {Collection} values - values to set -* @param {Options} [options] - function options -* @param {string} [options.mode='repeat'] - string specifying behavior when the number of values does not equal the number of truthy mask values -* @throws {TypeError} first argument must be a collection -* @throws {TypeError} second argument must be a collection -* @throws {TypeError} third argument must be a collection -* @throws {TypeError} options argument must be an object -* @throws {Error} must provide valid options -* @throws {Error} insufficient values to satisfy mask array -* @throws {Error} number of values does not equal the number of truthy mask values -* @throws {TypeError} third argument cannot be safely cast to the data type of the first argument -* @returns {Collection} input array -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var mask = [ 0, 1, 1, 0 ]; -* var values = [ 20, 30 ]; -* -* var out = place( x, mask, values ); -* // returns [ 1, 20, 30, 4 ] -* -* var bool = ( out === x ); -* // returns true -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var mask = [ 0, 1, 1, 0 ]; -* var values = [ 30 ]; -* -* var out = place( x, mask, values ); -* // returns [ 1, 30, 30, 4 ] -* -* var bool = ( out === x ); -* // returns true -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var mask = [ 1, 1, 0, 1 ]; -* var values = [ 20, 30 ]; -* -* var out = place( x, mask, values ); -* // returns [ 20, 30, 3, 20 ] -* -* var bool = ( out === x ); -* // returns true -*/ -function place( x, mask, values ) { - var opts; - var err; - var xdt; - var vdt; - if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); - } - if ( !isCollection( mask ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array-like object. Value: `%s`.', mask ) ); - } - if ( !isCollection( values ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', values ) ); - } - opts = defaults(); - if ( arguments.length > 3 ) { - err = validate( opts, arguments[ 3 ] ); - if ( err ) { - throw err; - } - } - xdt = dtype( x ) || 'generic'; - vdt = dtype( values ) || 'generic'; - - // Safe casts are always allowed and allow same kind casts (i.e., downcasts) only when the input array data type is floating-point... - if ( !isMostlySafeCast( vdt, xdt ) ) { - throw new TypeError( format( 'invalid argument. Third argument cannot be safely cast to the input array data type. Data types: [%s, %s].', vdt, xdt ) ); - } - // When performing a real-to-complex assignment, interpret the real-valued array as containing real components with implied imaginary components equal to zero and explicitly convert to a complex-valued array... - if ( isComplexDataType( xdt ) && isRealDataType( vdt ) ) { - values = convert( values, xdt ); - } - // Replace values in the input array: - return base( x, mask, values, opts.mode ); -} - - -// EXPORTS // - -module.exports = place; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index e97ff3f..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,78 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var contains = require( '@stdlib/array-base-assert-contains' ).factory; -var format = require( '@stdlib/string-format' ); - - -// VARIABLES // - -var MODES = [ - 'strict', - 'non_strict', - 'strict_broadcast', - 'broadcast', - 'repeat' -]; -var isMode = contains( MODES ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - mode option -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'strict' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'mode', MODES.join( '", "' ), opts.mode ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index e7c6741..2aeeb06 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Replace elements of an array with provided values according to a provided mask 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,61 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.2", - "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1", - "@stdlib/array-base-assert-is-mostly-safe-data-type-cast": "^0.2.2", - "@stdlib/array-base-assert-is-real-data-type": "^0.2.1", - "@stdlib/array-base-place": "^0.1.1", - "@stdlib/array-convert": "^0.2.1", - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/assert-is-plain-object": "^0.2.2", - "@stdlib/string-format": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled-by": "^0.2.2", - "@stdlib/array-base-linspace": "^0.2.2", - "@stdlib/array-base-ones": "^0.2.2", - "@stdlib/array-base-to-accessor-array": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-bool": "^0.1.0", - "@stdlib/array-complex64": "^0.3.0", - "@stdlib/array-int32": "^0.2.2", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/assert-is-accessor-array": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-complex64": "^0.2.2", - "@stdlib/complex-float32-ctor": "^0.0.2", - "@stdlib/complex-float32-imag": "^0.1.1", - "@stdlib/complex-float32-real": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "@stdlib/random-base-bernoulli": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c625844 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index d9116db..0000000 --- a/test/test.js +++ /dev/null @@ -1,696 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var Int32Array = require( '@stdlib/array-int32' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var zeros = require( '@stdlib/array-zeros' ); -var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -var isAccessorArray = require( '@stdlib/assert-is-accessor-array' ); -var Complex64 = require( '@stdlib/complex-float32-ctor' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var place = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof place, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided a first argument which is not a collection', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - place( value, [], [] ); - }; - } -}); - -tape( 'the function throws an error if provided a first argument which is not a collection (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - place( value, [], [], {} ); - }; - } -}); - -tape( 'the function throws an error if provided a second argument which is not a collection', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - place( [], value, [] ); - }; - } -}); - -tape( 'the function throws an error if provided a second argument which is not a collection (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - place( [], value, [], {} ); - }; - } -}); - -tape( 'the function throws an error if provided a third argument which is not a collection', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - place( [], [], value ); - }; - } -}); - -tape( 'the function throws an error if provided a third argument which is not a collection (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - place( [], [], value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - place( [], [], [], value ); - }; - } -}); - -tape( 'the function throws an error if provided a `mode` option which is not a valid mode', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - place( [], [], [], { - 'mode': value - }); - }; - } -}); - -tape( 'the function throws an error if provided a third argument which cannot be safely cast to the input array data type', function test( t ) { - var values; - var x; - var i; - - values = zeros( 5, 'float64' ); - - x = [ - zeros( 5, 'uint8' ), - zeros( 5, 'int8' ), - zeros( 5, 'int16' ), - zeros( 5, 'uint16' ) - ]; - for ( i = 0; i < x.length; i++ ) { - t.throws( badValue( x[ i ] ), TypeError, 'throws an error when provided ' + x[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - place( value, zeros( 5, 'generic' ), values ); - }; - } -}); - -tape( 'the function replaces elements in an array (generic)', function test( t ) { - var expected; - var actual; - var mask; - var x; - - x = [ 1, 2, 3, 4 ]; - mask = [ 0, 1, 0, 1 ]; - actual = place( x, mask, [ 20, 40 ] ); - expected = [ 1, 20, 3, 40 ]; - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = [ 1, 2, 3, 4 ]; - mask = [ 1, 1, 1, 1 ]; - actual = place( x, mask, [ 20, 30, 40, 50 ] ); - expected = [ 20, 30, 40, 50 ]; - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = [ 1, 2, 3, 4 ]; - mask = [ 0, 0, 0, 0 ]; - actual = place( x, mask, [ 20, 30, 40, 50 ] ); - expected = [ 1, 2, 3, 4 ]; - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function replaces elements in an array (generic, broadcasting)', function test( t ) { - var expected; - var actual; - var mask; - var x; - - x = [ 1, 2, 3, 4 ]; - mask = [ 0, 1, 0, 1 ]; - actual = place( x, mask, [ 20 ] ); - expected = [ 1, 20, 3, 20 ]; - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = [ 1, 2, 3, 4 ]; - mask = [ 1, 1, 1, 1 ]; - actual = place( x, mask, [ 20 ] ); - expected = [ 20, 20, 20, 20 ]; - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = [ 1, 2, 3, 4 ]; - mask = [ 0, 0, 0, 0 ]; - actual = place( x, mask, [ 20 ] ); - expected = [ 1, 2, 3, 4 ]; - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = [ 1, 2, 3, 4 ]; - mask = [ 1, 1, 1, 1 ]; - actual = place( x, mask, [ 100, 200 ] ); - expected = [ 100, 200, 100, 200 ]; - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function replaces elements in an array (typed)', function test( t ) { - var expected; - var actual; - var mask; - var x; - - x = new Int32Array( [ 1, 2, 3, 4 ] ); - mask = [ 0, 1, 0, 1 ]; - actual = place( x, mask, new Int32Array( [ 20, 40 ] ) ); - expected = new Int32Array( [ 1, 20, 3, 40 ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Int32Array( [ 1, 2, 3, 4 ] ); - mask = [ 1, 1, 1, 1 ]; - actual = place( x, mask, new Int32Array( [ 20, 30, 40, 50 ] ) ); - expected = new Int32Array( [ 20, 30, 40, 50 ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Int32Array( [ 1, 2, 3, 4 ] ); - mask = [ 0, 0, 0, 0 ]; - actual = place( x, mask, new Int32Array( [ 20, 30, 40, 50 ] ) ); - expected = new Int32Array( [ 1, 2, 3, 4 ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function replaces elements in an array (typed, broadcasting)', function test( t ) { - var expected; - var actual; - var mask; - var x; - - x = new Int32Array( [ 1, 2, 3, 4 ] ); - mask = [ 0, 1, 0, 1 ]; - actual = place( x, mask, new Int32Array( [ 20 ] ) ); - expected = new Int32Array( [ 1, 20, 3, 20 ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Int32Array( [ 1, 2, 3, 4 ] ); - mask = [ 1, 1, 1, 1 ]; - actual = place( x, mask, new Int32Array( [ 20 ] ) ); - expected = new Int32Array( [ 20, 20, 20, 20 ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Int32Array( [ 1, 2, 3, 4 ] ); - mask = [ 0, 0, 0, 0 ]; - actual = place( x, mask, new Int32Array( [ 20 ] ) ); - expected = new Int32Array( [ 1, 2, 3, 4 ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - x = new Int32Array( [ 1, 2, 3, 4 ] ); - mask = [ 1, 1, 1, 1 ]; - actual = place( x, mask, new Int32Array( [ 100, 200 ] ) ); - expected = new Int32Array( [ 100, 200, 100, 200 ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function replaces elements in an array (accessors)', function test( t ) { - var expected; - var actual; - var mask; - var x; - - x = [ 1, 2, 3, 4 ]; - mask = toAccessorArray( [ 0, 1, 0, 1 ] ); - actual = place( toAccessorArray( x ), mask, toAccessorArray( [ 20, 40 ] ) ); - expected = [ 1, 20, 3, 40 ]; - t.strictEqual( isAccessorArray( actual ), true, 'returns expected value' ); - t.deepEqual( x, expected, 'returns expected value' ); - - x = [ 1, 2, 3, 4 ]; - mask = toAccessorArray( [ 1, 1, 1, 1 ] ); - actual = place( toAccessorArray( x ), mask, toAccessorArray( [ 20, 30, 40, 50 ] ) ); // eslint-disable-line max-len - expected = [ 20, 30, 40, 50 ]; - t.strictEqual( isAccessorArray( actual ), true, 'returns expected value' ); - t.deepEqual( x, expected, 'returns expected value' ); - - x = [ 1, 2, 3, 4 ]; - mask = toAccessorArray( [ 0, 0, 0, 0 ] ); - actual = place( toAccessorArray( x ), mask, [ 20, 30, 40, 50 ] ); - expected = [ 1, 2, 3, 4 ]; - t.strictEqual( isAccessorArray( actual ), true, 'returns expected value' ); - t.deepEqual( x, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function replaces elements in an array (accessors, broadcasting)', function test( t ) { - var expected; - var actual; - var mask; - var x; - - x = [ 1, 2, 3, 4 ]; - mask = toAccessorArray( [ 0, 1, 0, 1 ] ); - actual = place( toAccessorArray( x ), mask, toAccessorArray( [ 20 ] ) ); - expected = [ 1, 20, 3, 20 ]; - t.strictEqual( isAccessorArray( actual ), true, 'returns expected value' ); - t.deepEqual( x, expected, 'returns expected value' ); - - x = [ 1, 2, 3, 4 ]; - mask = toAccessorArray( [ 1, 1, 1, 1 ] ); - actual = place( toAccessorArray( x ), mask, toAccessorArray( [ 20 ] ) ); - expected = [ 20, 20, 20, 20 ]; - t.strictEqual( isAccessorArray( actual ), true, 'returns expected value' ); - t.deepEqual( x, expected, 'returns expected value' ); - - x = [ 1, 2, 3, 4 ]; - mask = toAccessorArray( [ 0, 0, 0, 0 ] ); - actual = place( toAccessorArray( x ), mask, toAccessorArray( [ 20 ] ) ); - expected = [ 1, 2, 3, 4 ]; - t.strictEqual( isAccessorArray( actual ), true, 'returns expected value' ); - t.deepEqual( x, expected, 'returns expected value' ); - - x = [ 1, 2, 3, 4 ]; - mask = toAccessorArray( [ 1, 1, 1, 1 ] ); - actual = place( toAccessorArray( x ), mask, toAccessorArray( [ 100, 200 ] ) ); // eslint-disable-line max-len - expected = [ 100, 200, 100, 200 ]; - t.strictEqual( isAccessorArray( actual ), true, 'returns expected value' ); - t.deepEqual( x, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function replaces elements in an array (accessors, complex)', function test( t ) { - var expected; - var actual; - var values; - var mask; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - mask = toAccessorArray( [ 0, 1, 0, 1 ] ); - values = new Complex64Array( [ 30.0, 40.0, 70.0, 80.0 ] ); - expected = [ - new Complex64( 1.0, 2.0 ), - new Complex64( 30.0, 40.0 ), - new Complex64( 5.0, 6.0 ), - new Complex64( 70.0, 80.0 ) - ]; - actual = place( x, mask, values ); - - t.strictEqual( actual, x, 'returns expected value' ); - for ( i = 0; i < mask.length; i++ ) { - v = actual.get( i ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected[ i ] ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected[ i ] ), 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function replaces elements in an array (accessors, complex, broadcasting)', function test( t ) { - var expected; - var actual; - var values; - var mask; - var x; - var v; - var i; - - x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - mask = toAccessorArray( [ 0, 1, 0, 1 ] ); - values = new Complex64Array( [ 100.0, 200.0 ] ); - expected = [ - new Complex64( 1.0, 2.0 ), - new Complex64( 100.0, 200.0 ), - new Complex64( 5.0, 6.0 ), - new Complex64( 100.0, 200.0 ) - ]; - actual = place( x, mask, values ); - - t.strictEqual( actual, x, 'returns expected value' ); - for ( i = 0; i < mask.length; i++ ) { - v = actual.get( i ); - t.strictEqual( isComplex64( v ), true, 'returns expected value' ); - t.strictEqual( realf( v ), realf( expected[ i ] ), 'returns expected value' ); - t.strictEqual( imagf( v ), imagf( expected[ i ] ), 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function replaces elements in an array (accessors, boolean)', function test( t ) { - var expected; - var actual; - var values; - var mask; - var x; - var v; - var i; - - x = new BooleanArray( [ true, false, false, true ] ); - mask = toAccessorArray( [ 0, 1, 0, 1 ] ); - values = new BooleanArray( [ true, false ] ); - expected = [ true, true, false, true ]; - actual = place( x, mask, values ); - - t.strictEqual( actual, x, 'returns expected value' ); - for ( i = 0; i < mask.length; i++ ) { - v = actual.get( i ); - t.strictEqual( v, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function replaces elements in an array (accessors, boolean, broadcasting)', function test( t ) { - var expected; - var actual; - var values; - var mask; - var x; - var v; - var i; - - x = new BooleanArray( [ true, false, false, true ] ); - mask = toAccessorArray( [ 0, 1, 1, 0 ] ); - values = new BooleanArray( [ true ] ); - expected = [ true, true, true, true ]; - actual = place( x, mask, values ); - - t.strictEqual( actual, x, 'returns expected value' ); - for ( i = 0; i < mask.length; i++ ) { - v = actual.get( i ); - t.strictEqual( v, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'when the "mode" is "strict", the function throws an error if provided insufficient values to satisfy the mask array', function test( t ) { - var mask; - var x; - - x = [ 1, 2, 3, 4 ]; - mask = [ 1, 1, 1, 1 ]; - - t.throws( badValue, Error, 'throws an error' ); - t.end(); - - function badValue() { - place( x, mask, [ 200 ], { - 'mode': 'strict' - }); - } -}); - -tape( 'when the "mode" is "strict", the function throws an error if provided too many values to satisfy the mask array', function test( t ) { - var mask; - var x; - - x = [ 1, 2, 3, 4 ]; - mask = [ 1, 1, 1, 1 ]; - - t.throws( badValue, Error, 'throws an error' ); - t.end(); - - function badValue() { - place( x, mask, [ 200, 300, 400, 500, 600 ], { - 'mode': 'strict' - }); - } -}); - -tape( 'when the "mode" is "non_strict", the function throws an error if provided insufficient values to satisfy the mask array', function test( t ) { - var mask; - var x; - - x = [ 1, 2, 3, 4 ]; - mask = [ 1, 1, 1, 1 ]; - - t.throws( badValue, Error, 'throws an error' ); - t.end(); - - function badValue() { - place( x, mask, [ 200 ], { - 'mode': 'non_strict' - }); - } -}); - -tape( 'when the "mode" is "strict_broadcast", the function throws an error if provided a values array which is broadcast incompatible with the number of truthy values in a mask array (insufficient)', function test( t ) { - var mask; - var x; - - x = [ 1, 2, 3, 4 ]; - mask = [ 1, 1, 1, 1 ]; - - t.throws( badValue, Error, 'throws an error' ); - t.end(); - - function badValue() { - place( x, mask, [ 200, 400 ], { - 'mode': 'strict_broadcast' - }); - } -}); - -tape( 'when the "mode" is "strict_broadcast", the function throws an error if provided a values array which is broadcast incompatible with the number of truthy values in a mask array (too many)', function test( t ) { - var mask; - var x; - - x = [ 1, 2, 3, 4 ]; - mask = [ 1, 1, 1, 1 ]; - - t.throws( badValue, Error, 'throws an error' ); - t.end(); - - function badValue() { - place( x, mask, [ 200, 400, 500, 600, 700 ], { - 'mode': 'strict_broadcast' - }); - } -}); - -tape( 'when the "mode" is "broadcast", the function throws an error if provided a values array which is broadcast incompatible with the number of truthy values in a mask array', function test( t ) { - var mask; - var x; - - x = [ 1, 2, 3, 4 ]; - mask = [ 1, 1, 1, 1 ]; - - t.throws( badValue, Error, 'throws an error' ); - t.end(); - - function badValue() { - place( x, mask, [ 200, 400 ], { - 'mode': 'broadcast' - }); - } -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 5023921..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,128 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if not provided an options object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[i] ); - t.strictEqual( err instanceof TypeError, true, 'returns an error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `mode` option which is not a valid index mode', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'mode': values[i] - }); - t.strictEqual( err instanceof TypeError, true, 'returns an error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var expected; - var options; - var opts; - var err; - - options = { - 'mode': 'strict' - }; - opts = {}; - - expected = { - 'mode': 'strict' - }; - - err = validate( opts, options ); - - t.strictEqual( err, null, 'returns expected value' ); - t.deepEqual( opts, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': 'boop', - 'foo': 5, - 'bar': {} - }; - - opts = {}; - - err = validate( opts, options ); - - t.strictEqual( err, null, 'returns expected value' ); - t.deepEqual( opts, {}, 'returns expected value' ); - - t.end(); -});